{"_id":"56b5265b168b5c1700c15996","__v":12,"githubsync":"","user":"5582e90181672a3900bb4fc7","project":"569f9cf6650e1d1900f96b5b","category":{"_id":"56b25826147e900d00d6497a","project":"569f9cf6650e1d1900f96b5b","version":"569f9cf6650e1d1900f96b5e","pages":["56b2583a9621f20d00efb31c","56b25a3965ddf50d0076baa2","56b2738894ab060d0006743c","56b4d1cf5f1cf00d00cc46d7","56b4f4e2b1a8690d00a59369","56b4f6925f1cf00d00cc4704","56b4fa3d5997532100bc6bcc","56b50ba8eed075230097d71e","56b5123585a6922300d1c506","56b51e475997532100bc6c08","56b5220b7719bb1900143055","56b524cc3d5f130d00dad1b8","56b5265b168b5c1700c15996","56b774438fb4420d006a618b","56b78012eb783a0d007894f3","56b78292a6c10c0d00a2d65d","56b7863aeb783a0d007894f8","56b78f68a6c10c0d00a2d66b","56b794566c2a240d0094ae8a","56b7a85dd22adc0d0053f4c2","56b7ac118fb4420d006a61b7"],"__v":21,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-03T19:42:30.051Z","from_sync":false,"order":7,"slug":"user-methods","title":"User methods"},"version":{"_id":"569f9cf6650e1d1900f96b5e","project":"569f9cf6650e1d1900f96b5b","__v":12,"createdAt":"2016-01-20T14:43:02.785Z","releaseDate":"2016-01-20T14:43:02.785Z","categories":["569f9cf7650e1d1900f96b5f","56abdd81d4432d1900eed235","56abe0558beeff0d003b8118","56ad2f8b1c09150d00a183a8","56ad4e1cd21f1b0d00fd2f97","56b00ad88f7a4f0d0029dc92","56b2432e9621f20d00efb2bd","56b25826147e900d00d6497a","56b7af2a4b372d2100722c48","56b8c4d938b1070d0028920f","56b8cdab14feef0d0082415d","58599813cf9e112d0032cdab"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-05T22:46:51.699Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[]},"results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":13,"body":"## Syntax \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  <credentials object>\\n  \\\"user\\\": <mailbox_name>,\\n  \\\"ids\\\": [<list of message ids>] \\n  \\\"folder\\\": <destination folder>\\n}\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request fields for move_user_messages\"\n}\n[/block]\nThe following fields can be used in the **move_user_messages** method:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Definition/Value\",\n    \"0-0\": \"folder\",\n    \"0-1\": \"Optional\",\n    \"0-2\": \"The folder to search for messages. If not specified, the INBOX folder is searched.\",\n    \"1-0\": \"ids\",\n    \"1-1\": \"Required\",\n    \"1-2\": \"The list of ids that you want to move.\\n\\nThe ids are returned by the [get_user_messages](https://api-opensrs-email.readme.io/v1.0/docs/get_deleted_messages?bypass=8272e34bb5) method.\",\n    \"2-0\": \"user\",\n    \"2-1\": \"Required\",\n    \"2-2\": \"The user's account name.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response fields for move_user_messages\"\n}\n[/block]\nThe following fields may be returned in response to the **move_user_messages** method:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Description/Value\",\n    \"0-0\": \"count\",\n    \"0-1\": \"Returned if **success = true**\",\n    \"0-2\": \"The number of messages returned in the **messages** list.\",\n    \"1-0\": \"error\",\n    \"1-1\": \"Returned if **success = false**\",\n    \"1-2\": \"A text string that explains the error.\",\n    \"2-0\": \"error_number\",\n    \"2-1\": \"Returned if **success = false**\",\n    \"2-2\": \"A number that represents the error.\",\n    \"3-0\": \"ids\",\n    \"3-1\": \"Returned if **success = true**\",\n    \"3-2\": \"A list of hashes, one for each of the message ids submitted in the request. Includes the following information for each message listed:\\n\\n  * **error**—A text string that explains the error.\\n\\n  * **error_number**—A number that represents the error.\\n\\n  * **id**—The id number of the message.\\n\\n  * **success**—Indicates whether the message was moved successfully or not. Allowed values are **true** and **false**.\",\n    \"4-0\": \"success\",\n    \"4-1\": \"Always returned\",\n    \"4-2\": \"Indicates whether the request was successful or not. Allowed values are **true** and **false**.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples for move_user_messages\"\n}\n[/block]\n**Request** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"credentials\\\": {\\n\\t\\t\\\"user\\\": \\\"domain_admin:::at:::example.com\\\",\\n    \\\"password\\\": \\\"pencil75\\\"\\n  },\\n  \\\"user\\\": \\\"joe_user@example.com\\\",\\n  \\\"folder\\\": \\\"Spam\\\",\\n  \\\"ids\\\": [\\n\\t\\t\\\"U2FsdGVkX1/1NoyVE6nnFbezjndojMCc+wKwHMv6al2buE2jNziDQTGzZUA7Gb0ivD u/6v0fJWAIrR2S0\\\"\\n\\t] \\n}\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]\n**Response** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"success\\\": true,\\n  \\\"ids\\\": [\\n    {\\n      \\\"success\\\": true,\\n      \\\"id\\\": \\\"U2FsdGVkX1/1NoyVE6nnFbezjndojMCc+wKwHMv6al2buE2jNziDQTGzZUA7Gb0ivDu/6v 0fJWAIrR2S0\\\"\\n\\t\\t} \\n\\t],\\n}\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]","excerpt":"The **move_user_messages** method moves the specified user messages to a different folder.","slug":"move_user_messages","type":"basic","title":"move_user_messages"}

move_user_messages

The **move_user_messages** method moves the specified user messages to a different folder.

## Syntax [block:code] { "codes": [ { "code": "{\n <credentials object>\n \"user\": <mailbox_name>,\n \"ids\": [<list of message ids>] \n \"folder\": <destination folder>\n}", "language": "perl", "name": " " } ] } [/block] [block:api-header] { "type": "basic", "title": "Request fields for move_user_messages" } [/block] The following fields can be used in the **move_user_messages** method: [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Definition/Value", "0-0": "folder", "0-1": "Optional", "0-2": "The folder to search for messages. If not specified, the INBOX folder is searched.", "1-0": "ids", "1-1": "Required", "1-2": "The list of ids that you want to move.\n\nThe ids are returned by the [get_user_messages](https://api-opensrs-email.readme.io/v1.0/docs/get_deleted_messages?bypass=8272e34bb5) method.", "2-0": "user", "2-1": "Required", "2-2": "The user's account name." }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Response fields for move_user_messages" } [/block] The following fields may be returned in response to the **move_user_messages** method: [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Description/Value", "0-0": "count", "0-1": "Returned if **success = true**", "0-2": "The number of messages returned in the **messages** list.", "1-0": "error", "1-1": "Returned if **success = false**", "1-2": "A text string that explains the error.", "2-0": "error_number", "2-1": "Returned if **success = false**", "2-2": "A number that represents the error.", "3-0": "ids", "3-1": "Returned if **success = true**", "3-2": "A list of hashes, one for each of the message ids submitted in the request. Includes the following information for each message listed:\n\n * **error**—A text string that explains the error.\n\n * **error_number**—A number that represents the error.\n\n * **id**—The id number of the message.\n\n * **success**—Indicates whether the message was moved successfully or not. Allowed values are **true** and **false**.", "4-0": "success", "4-1": "Always returned", "4-2": "Indicates whether the request was successful or not. Allowed values are **true** and **false**." }, "cols": 3, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Examples for move_user_messages" } [/block] **Request** [block:code] { "codes": [ { "code": "{\n \"credentials\": {\n\t\t\"user\": \"domain_admin@example.com\",\n \"password\": \"pencil75\"\n },\n \"user\": \"joe_user@example.com\",\n \"folder\": \"Spam\",\n \"ids\": [\n\t\t\"U2FsdGVkX1/1NoyVE6nnFbezjndojMCc+wKwHMv6al2buE2jNziDQTGzZUA7Gb0ivD u/6v0fJWAIrR2S0\"\n\t] \n}", "language": "perl", "name": " " } ] } [/block] **Response** [block:code] { "codes": [ { "code": "{\n \"success\": true,\n \"ids\": [\n {\n \"success\": true,\n \"id\": \"U2FsdGVkX1/1NoyVE6nnFbezjndojMCc+wKwHMv6al2buE2jNziDQTGzZUA7Gb0ivDu/6v 0fJWAIrR2S0\"\n\t\t} \n\t],\n}", "language": "perl", "name": " " } ] } [/block]