{"_id":"56b4fa3d5997532100bc6bcc","user":"5582e90181672a3900bb4fc7","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"},"githubsync":"","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"},"__v":101,"project":"569f9cf6650e1d1900f96b5b","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-05T19:38:37.113Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"## Syntax \n\n**Request** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    <credentials object>,\\n    \\\"user\\\": <mailbox_name>\\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\\t\\t\\\"settable_attributes\\\": [<attribute names>], \\n    \\\"type\\\": mailbox | filter | forward, \\n    \\\"metadata\\\":\\n\\t\\t{\\n        \\\"2fa_enabled\\\": <boolean>\\n\\t\\t\\t\\t\\\"roles\\\": {role name: [<list of objects>]} \\n        \\\"quota\\\": {\\n\\t\\t\\t\\t\\t\\t\\\"bytes_max\\\": <number of bytes in quota>, \\n            \\\"bytes_used\\\": <number of bytes used>, \\n            \\\"messages_max\\\": <number of messages in quota>, \\n            \\\"messages_used\\\": <number of messages>\\n\\t\\t\\t\\t},\\n\\t\\t\\t\\t\\\"folders\\\": [list of email folder names] \\n\\t\\t\\t\\t\\\"special_folders\\\": {\\n\\t\\t\\t\\t\\t\\t\\\"spam\\\": <user's spam folder name> }\\n\\t\\t\\t\\t\\\"options\\\": { <key-value pairs>}, \\n\\t\\t\\t\\t\\\"addressbook\\\": {\\n        \\t\\t\\\"contacts\\\": <number of contacts in user's webmail address\\nbook>,\\n\\t\\t\\t\\t\\t\\t\\\"groups\\\": <number of groups in user's webmail address\\nbook>,\\n\\t\\t\\t\\t\\t\\t\\\"total\\\": <number of contacts and groups in user's webmail\\naddress book>,\\n\\t\\t\\t\\t\\t\\t\\\"max\\\": <maximum number of contacts and groups allowed>\\n        },\\n       \\t\\\"app_passwords\\\": {\\n          [\\n            { \\n              \\\"created\\\": <unix timestamp>,\\n              \\\"tag\\\": <string>\\n            },\\n            ...\\n          ]\\n\\t\\t\\t\\t\\\"createtime\\\": <mailbox creation time>, \\n        \\\"smtp_limit\\\": {\\n\\t\\t\\t\\t\\t\\t\\\"when\\\": {<time when limits apply>},\\n\\t\\t\\t\\t\\t\\t\\\"max\\\": <maximum number of messages that user may send in a\\n24 hour period>,\\n\\t\\t\\t\\t\\t\\t\\\"sent\\\": <number of messages sent in the last 24 hour\\nperiod>,\\n\\t\\t\\t\\t\\t\\t\\\"free_passes\\\": <number of free passes available to the\\nuser>,\\n\\t\\t\\t\\t\\t\\t\\\"free_passes_remaining\\\": <number of free passes remaining\\nin the 24 hour period>\\n\\t\\t\\t\\t}\\n        \\\"inherit\\\": {\\n        \\t\\t\\\"brand\\\": <brand>, \\n        \\t\\t\\\"default_password_encoding\\\": <encoding type>, \\n        \\t\\t\\\"filterdelivery\\\": <quarantine | passthrough>, \\n        \\t\\t\\\"smtp_sent_limit\\\": <number>,\\n\\t\\t\\t\\t\\t\\t\\\"spamfolder\\\": <folder>, \\n        \\t\\t\\\"spamheader\\\":<header>,\\n\\t\\t\\t\\t\\t\\t\\\"spamtag\\\": <tag>,\\n\\t\\t\\t\\t\\t\\t\\\"spamlevel\\\": <level>\\n        }\\n\\t\\t\\t\\t\\\"lastlogin\\\": <last login as UNIX epoch time>,\\n\\t\\t\\t\\t\\\"status\\\": active | deleted | suspended | quota | smtplimit\\n}\\n    \\\"attributes\\\": { <key-value pairs>}\\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 get_user\"\n}\n[/block]\nThe following fields can be used in the **get_user** method:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Definition/Value\",\n    \"0-0\": \"user\",\n    \"0-1\": \"Required\",\n    \"0-2\": \"The user's email address.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response fields for get_user\"\n}\n[/block]\nThe following fields may be returned in response to the **get_user** method:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Description/Value\",\n    \"0-0\": \"attributes\",\n    \"0-1\": \"Returned if **success = true**\",\n    \"0-2\": \"The user's current account settings.\\n\\nFor more information, see the **Attributes** table below.\",\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\": \"metadata\",\n    \"3-1\": \"Always returned\",\n    \"3-2\": \"A list of the account settings that can be set for a new user or changed for an existing user.\\n\\nAllowed values are:\\n\\n * **2fa_enabled** -- Shows the 2FA enrolment status of the user\\n\\n * **app_passwords** -- Any existing App Password tags, along with when they were created.\\n\\n  * **addressbook** — The limits and usage of the user's address book. Includes the following:\\n  \\n   * **contacts** — The number of contacts in the user's address book.\\n   \\n   * **deleted_contacts**: A count of the user’s deleted contacts that may be available for restoration (if the backup exists).\\n   \\n   * **groups** — The number of groups in the user's address book.\\n   \\n   * **max** — The maximum number of contacts and groups that the user can have in the address book.\\n   \\n   * **total** — The total number of contacts and groups that are currently in the user's address book.\\n\\n  * **createtime** — The date that the account was created. \\n\\n  * **defaults** — Returned if the user does not already exist. Indicates the settings that would apply to a new user if not explicitly set. These values are inherited from the domain level. Allowed values are **delivery, language, quota**, and **timezone**. See the **Attributes** table for an explanation of each of these values.\\n\\n  * **folders** — A list of the user's email folders.\\n\\n  * **inherit** — The domain level values that will be assigned if they are not explicity set for this user. Includes the following:\\n\\n   * **brand** — The Webmail brand for this mailbox.\\n   \\n   * **default_password_encoding** — The type of password hashing/encoding to be performed when OpenSRS receives an unencrypted password.\\n   \\n   * **filterdelivery** — The way in which spam messages are handled.\\n    \\n   * **smtp_sent_limit** — The number of messages that the user is allowed to send in a 24 hour period.\\n    \\n   * **spamfolder** — The folder into which messages identified as spam will be delivered.\\n   \\n   * **spamheader** — The tag that is added to messages that are identified as spam.\\n    \\n   * **spamtag** — The value of this field is prepended to the subject of any message that is identified as spam.\\n   \\n   * **spamlevel** — The level of aggressiveness set for the spam filter.\\n\\n  * **lastlogin** — The last time the user logged in to the mailbox, expressed as a UNIX epoch time. \\n\\n **Note**: This is the same data that is available through the stats_snapshot method;; it is not real time data and may be 24-48 hours behind.\\n\\n  * **mailstore** — The storage subsystem that is holding the user's mail.\\n  \\n  * **options** — The list of account settings that can be set or changed for a user. Includes all available values for each setting to allow a UI client to populate a page of attributes and drop-down options.\\nAllowed settings are **brand, language, quota, spamlevel, timezone**, and **workgroup**. For an explanation of each of these values, see the Attributes table for an explanation of each of these values.\\n\\n  * **quota** — The amount of storage this user is consuming, and their maximum . Includes bytes_max (in bytes), messages_used, messages_max, and bytes_used (in bytes).\\n  \\n  * **roles** — The user's admin level, and the objects owned at that level.\\n  \\n  * **smtp_limit** — The maximum number of messages that this user is allowed to send in a 24 hour period. Includes the following:\\n\\n   * **free_passes** — The number of messages the user is allowed to send that have been identified as spam or that may contain viruses\\n   \\n   * **free_passes_remaining**      — The number of free passes remaining in the 24 hour window\\n   \\n   * **max** — The maximum number of messages allowed.\\n   \\n   * **sent** — The number of messages that were sent in the last 24 hours.\\n   \\n   * **when** — The time (in UNIX Epoch time) when the user may send an email to some given number of recipients, or 0 if the user could send to that number of recipients immediately or -1 if the user will never be able to send to that number of recipients (because the number is greater than the user's **max**).\\n\\n  * **special_folders** — The user's spam folder - the folder in which messages that are determined to be spam will be stored.\\n  \\n  * **status** — The mailbox status. Allowed values are:\\n\\n   * **active** — The mailbox is currently active.\\n   \\n   * **deleted** — The mailbox has been deleted.\\n    \\n   * **suspended** — The mailbox has been suspended and the user cannot send or receive mail.\\n    \\n   * **quota** — The mailbox is over quota and cannot receive any more mail.\\n   \\n   * **smtplimit** — The mailbox is at the smtp limit and the user cannot send any more mail. The smtp limit applies to a sliding 24 hour period, so as time goes by, this status changes.\",\n    \"4-0\": \"settable_attributes\",\n    \"4-1\": \"Always returned\",\n    \"4-2\": \"The list of attributes that can be set for a new user or changed for an existing user.\\n\\nAllowed values are: \\n\\n**aliases, allow, autoresponder, autoresponder_option_enddate, autoresponder_option_interval, block, brand, delivery_autoresponder, delivery_filter, delivery_forward, delivery_local, fax, filterdelivery,** **forward_option_reply_to, forward_option_restricted, forward_option_subject_prefix, forward_recipients, language, macsettings, name, notes_external, password, phone, quota, reject_spam, service_imap4, service_pop3,** **service_smtpin, service_smtprelay, service_smtprelay_webmail, service_webmail, sieve, spamfolder,** **apam_header, spamlevel, spamtag, timezone, title, workgroup.** \\n\\nFor an explanation of each of these attributes, see the **Attributes** table below.\",\n    \"5-0\": \"success\",\n    \"5-1\": \"Always returned\",\n    \"5-2\": \"Indicates whether the request was successful or not. Allowed values are **true** and **false**.\",\n    \"6-0\": \"type\",\n    \"6-1\": \"Returned if **success = true**\",\n    \"6-2\": \"The type of account. Allowed values are **mailbox, filter, forward**, or **alias**.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n## Attributes fields \n\nThe following fields may be returned within the **attributes** array.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Definition/Value\",\n    \"0-0\": \"account\",\n    \"0-1\": \"Always returned\",\n    \"0-2\": \"The user's complete email address, for example, joe_user:::at:::example.com.\",\n    \"1-0\": \"aliases\",\n    \"1-1\": \"Optional\",\n    \"1-2\": \"The list of alternate names for the account, for example, joe@example.com, joey@example.com, juser@example.com. Mail that is sent to an alias address is delivered to the account. The alias address can be used to log in to the account via IMAP4, POP3, Webmail and SMTP\\n\\nThe maximum number of aliases is 2000.\",\n    \"2-0\": \"allow\",\n    \"2-1\": \"Optional\",\n    \"2-2\": \"A list of email addresses on the user's allow list;; may include wildcards. For example joe_goodguy@bigmail.com and *@example.com. Maximum is 1000 addresses.\",\n    \"3-0\": \"autoresponder\",\n    \"3-1\": \"Optional\",\n    \"3-2\": \"The text of the message that is automatically sent back to senders if **delivery_autoresponder** is set to **true**. Maximum size is 4000 characters.\",\n    \"4-0\": \"autoresponder_option_enddate\",\n    \"4-1\": \"Optional\",\n    \"4-2\": \"The date that the autoresponder expires, expressed in UNIX Epoch time. If not specified, the autoresponder never expires.\",\n    \"5-0\": \"autoresponder_option_interval\",\n    \"5-1\": \"Optional\",\n    \"5-2\": \"The number of hours that must pass before the autoresponder message is sent again to the same address. Must be less than 1095 (3 years) If not set, an interval of 24 hours is used.\",\n    \"6-0\": \"block\",\n    \"6-1\": \"Optional\",\n    \"6-2\": \"A list of email addresses on the user's block list;; may include wildcards. For example, bob_thejerk@othermail.com and *@spammers-inc.com. Messages from these addresses will always be considered to be spam. Maximum is 1000 addresses.\",\n    \"7-0\": \"brand\",\n    \"7-1\": \"Optional\",\n    \"7-2\": \"The Webmail brand for this mailbox. If not specified, the account uses the domain setting.\",\n    \"8-0\": \"delivery_autoresponder\",\n    \"8-1\": \"Optional\",\n    \"8-2\": \"If set to **true**, the configured auto response message is sent to the sender.\",\n    \"9-0\": \"delivery_filter\",\n    \"9-1\": \"Optional\",\n    \"9-2\": \"If set to **true**, messages are scanned and then passed to the domain's filter mx host;; the messages are not stored locally.\\n\\n**Note**: If **delivery_filter = true**, all other delivery attributes must be **false**.\",\n    \"10-0\": \"delivery_forward\",\n    \"11-0\": \"delivery_local\",\n    \"10-1\": \"Optional\",\n    \"10-2\": \"If set to **true**, the message is forwarded to the mailbox's **forward_recipients** list.\",\n    \"11-1\": \"Optional\",\n    \"11-2\": \"If set to **true**, the message is passed through the mailbox's sieve filters and stored locally.\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]\nThe following combinations of **delivery** attributes may be used:\n\n  * **delivery_local**—Mail is stored locally.\n  * **delivery_local, delivery_forward**—Mail is stored locally and forwarded.\n  * **delivery_forward**—Mail is forwarded.\n  * **delivery_local, delivery_autoresponder**—Mail is stored locally, automatic reply sent.\n  *** delivery_local, delivery_forward, delivery_autoresponder**—Mail is stored locally and forwarded, automatic reply sent.\n  * **delivery_forward, delivery_autoresponder**—Mail is forwarded, automatic reply sent.\n  * **delivery_filter**—Mail is forwarded to domain-defined mail host.\n\n**Note**: No matter which **delivery** setting you specify, incoming messages are always scanned for viruses, and, depending on the mailbox's allow list, scanned for spam.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Definition/Value\",\n    \"0-0\": \"fax\",\n    \"0-1\": \"Optional\",\n    \"0-2\": \"The fax number for the account owner;; maximum 30 characters.\",\n    \"1-0\": \"filterdelivery\",\n    \"1-1\": \"Optional\",\n    \"1-2\": \"Determines what happens to spam messages:\\n\\n  * **quarantine** — Spam messages are stored locally in the user's spam folder.\\n  \\n  * **passthrough** — Spam messages are delivered with the specified **spamtag** and **spamheader**.\\n\\nIf not defined, the account uses the domain's **filterdelivery** setting.\",\n    \"2-0\": \"forward_option_restricted\",\n    \"2-1\": \"Optional\",\n    \"2-2\": \"If set to **true** and **delivery_forward** is also set to **true**, only messages from addresses on the forward recipients list are forwarded.\",\n    \"3-0\": \"forward_option_subject_prefix\",\n    \"3-1\": \"Optional\",\n    \"3-2\": \"If **delivery_forward** is set to **true**, this string is added to the beginning of the **Subject** line of forwarded messages. String can be up to 128 characters.\",\n    \"4-0\": \"forward_option_reply_to\",\n    \"4-1\": \"Optional\",\n    \"4-2\": \"If **delivery_forward** is set to **true**, this email address is added to the **Reply-To** header of forwarded messages.\",\n    \"5-0\": \"forward_recipients\",\n    \"5-1\": \"Optional\",\n    \"5-2\": \"If **delivery_forward** is set to **true**, incoming messages will be forwarded to this list of addresses. Maximum number of addresses is 1000.\",\n    \"6-0\": \"language\",\n    \"6-1\": \"Optional\",\n    \"6-2\": \"The default language in which the mailbox will be displayed. May be overridden by the user.\",\n    \"7-0\": \"macsettings\",\n    \"7-1\": \"Optional\",\n    \"7-2\": \"A string that contains the user's MAC UI preferences. Only used by the MAC;; not recommended for use by other applications. Maximum 2048 characters.\",\n    \"8-0\": \"max_pab_entries\",\n    \"8-1\": \"Optional\",\n    \"8-2\": \"The maximum number of entries (contacts and groups) that the user can have in their address book.\",\n    \"9-0\": \"name\",\n    \"9-1\": \"Optional\",\n    \"9-2\": \"The name that is used in the From field of email messages. The format is UTF-8 text up to 512 characters.\",\n    \"10-0\": \"notes_external\",\n    \"10-1\": \"Always returned\",\n    \"10-2\": \"Any notes that were added through the **change_user** method. Maximum is 4096 characters. If there are no notes, returns **null**.\",\n    \"11-0\": \"password\",\n    \"11-1\": \"Optional\",\n    \"11-2\": \"Indicates whether a password is set.\\n\\nIf a password exists, it is displayed as ************\\n\\nIf there is no password, the returned value is **null**.\",\n    \"12-0\": \"phone\",\n    \"12-1\": \"Optional\",\n    \"12-2\": \"The user's phone number;; maximum 30 characters.\",\n    \"13-0\": \"quota\",\n    \"13-1\": \"Optional\",\n    \"13-2\": \"The maximum amount of storage (in bytes) that the mailbox may use, including mail and file storage.\",\n    \"14-0\": \"reject_spam\",\n    \"14-1\": \"Optional\",\n    \"14-2\": \"Indicates whether spam messages are rejected at the SMTP level. Allowed values are **true** and **false**.\",\n    \"15-0\": \"service_imap4\",\n    \"15-1\": \"Optional\",\n    \"15-2\": \"The current setting for the IMAP4 service (**enabled**, **disabled**, or **suspended**). If **enabled**, the user can log in via IMAP4.\",\n    \"16-0\": \"service_pop3\",\n    \"16-1\": \"Optional\",\n    \"16-2\": \"The current setting for the POP3 service (**enabled**, **disabled**, or **suspended**). If **enabled**, the user can log in via POP3.\",\n    \"17-0\": \"service_smtpin\",\n    \"17-1\": \"Optional\",\n    \"17-2\": \"The current setting for the SMTPIN service (enabled, disabled, or suspended). If enabled, the user can send email.\",\n    \"18-0\": \"service_smtprelay\",\n    \"18-1\": \"Optional\",\n    \"18-2\": \"The current setting for the SMTPRELAY service (**enabled**, **disabled**, or **suspended**).\",\n    \"19-0\": \"service_smtprelay_webmail\",\n    \"19-1\": \"Optional\",\n    \"19-2\": \"The current setting for the SMTPRELAY Webmail service (enabled, disabled, or suspended). If enabled, the user can send email via Webmail.\",\n    \"20-0\": \"service_webmail\",\n    \"20-1\": \"Optional\",\n    \"20-2\": \"The current setting for the Webmail service (**enabled**, **disabled**, or **suspended**). If **enabled**, the user can log in via Webmail.\"\n  },\n  \"cols\": 3,\n  \"rows\": 21\n}\n[/block]\n**Note:** If any of the above **service** values (that is, **service_imap4, service_pop3, service_smtpin, service_smtprelay, service_smtprelay_webmail** or **service_webmail**)are set to **suspended**, the service can only be set to **enabled** or **disabled** by an admin of the same or higher level (for example, a domain admin cannot change a service that was suspended by a company admin).\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Obligation\",\n    \"h-2\": \"Definition/Value\",\n    \"0-0\": \"sieve\",\n    \"0-1\": \"Optional\",\n    \"0-2\": \"The user's sieve filters.\",\n    \"1-0\": \"smtp_sent_limit\",\n    \"1-1\": \"Optional\",\n    \"1-2\": \"The number of messages that the user can send in a 24 hour period. Maximum number is 10,000. If not defined, the domain's **smtp_sent_limit** is used.\\n\\n**Note**: If the same message is sent to two recipients, it counts as two messages against this limit.\",\n    \"2-0\": \"spamfolder\",\n    \"2-1\": \"Optional\",\n    \"2-2\": \"The folder into which messages identified as spam will be delivered. Maximum 128 characters. Nested folders are separated by the '/' character, for example, \\\"Archive/Junk/Spam\\\" If not defined, the mailbox uses the domain's spamfolder setting.\",\n    \"3-0\": \"spamheader\",\n    \"3-1\": \"Optional\",\n    \"3-2\": \"The tag that is added to messages that are identified as spam. Maximum 512 characters.\",\n    \"4-0\": \"spamlevel\",\n    \"4-1\": \"Optional\",\n    \"4-2\": \"The level of aggressiveness set for the spam filter. Valid values are **Normal, High, and Very High**. If not set, the mailbox uses the domain's spamlevel setting.\",\n    \"5-0\": \"spamtag\",\n    \"5-1\": \"Optional\",\n    \"5-2\": \"The value of this field is prepended to the subject of any message that is identified as spam. Maximum 30 characters. If not defined, the mailbox uses the domain's **spamtag** setting.\\n\\n**Note**: This value is not supported for filteronly accounts.\",\n    \"6-0\": \"timezone\",\n    \"6-1\": \"Optional\",\n    \"6-2\": \"The timezone that the mailbox will use.\",\n    \"7-0\": \"title\",\n    \"7-1\": \"Optional\",\n    \"7-2\": \"The user's job title;; maximum 60 characters.\",\n    \"8-0\": \"workgroup\",\n    \"8-1\": \"Optional\",\n    \"8-2\": \"The workgroup to which the user belongs.\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples for get_user\"\n}\n[/block]\n## Example 1\n\nShows the result for joe_user@example.com who is near his smtp_sent limit and currently unable to send a message with 25 recipients.\n\n**Request** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"credentials\\\": {\\n    \\\"user\\\": \\\"admin@example.com\\\",\\n    \\\"password\\\": \\\"xyz\\\"\\n  },\\n  \\\"user\\\": \\\"joe_user@example.com\\\"\\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  \\\"settable_attributes\\\": [\\n    \\\"aliases\\\",\\n    \\\"allow\\\",\\n    \\\"autoresponder\\\",\\n    \\\"autoresponder_option_enddate\\\",\\n    \\\"autoresponder_option_interval\\\",\\n    \\\"block\\\",\\n    \\\"brand\\\",\\n    \\\"delivery_autoresponder\\\",\\n    \\\"delivery_filter\\\",\\n    \\\"delivery_forward\\\",\\n    \\\"delivery_local\\\",\\n    \\\"fax\\\",\\n    \\\"filterdelivery\\\",\\n    \\\"forward_option_reply_to\\\",\\n    \\\"forward_option_restricted\\\",\\n    \\\"forward_option_subject_prefix\\\",\\n    \\\"forward_recipients\\\",\\n    \\\"language\\\",\\n  \\t\\\"macsettings\\\",\\n  \\t\\\"name\\\",\\n  \\t\\\"notes_external\\\",\\n  \\t\\\"password\\\",\\n  \\t\\\"phone\\\",\\n  \\t\\\"quota\\\",\\n  \\t\\\"reject_spam\\\",\\n  \\t\\\"service_imap4\\\",\\n  \\t\\\"service_pop3\\\",\\n  \\t\\\"service_smtpin\\\",\\n  \\t\\\"service_smtprelay\\\",\\n  \\t\\\"service_smtprelay_webmail\\\",\\n  \\t\\\"service_webmail\\\",\\n  \\t\\\"sieve\\\",\\n  \\t\\\"spamfolder\\\",\\n  \\t\\\"spamheader\\\",\\n  \\t\\\"spamlevel\\\",\\n  \\t\\\"spamtag\\\",\\n  \\t\\\"timezone\\\",\\n  \\t\\\"title\\\",\\n  \\t\\\"workgroup\\\"\\n  ],\\n\\t\\\"type\\\": \\\"mailbox\\\",\\n\\t\\\"metadata\\\": {\\n  \\t\\\"roles\\\": {},\\n  \\t\\\"quota\\\": {\\n      \\\"bytes_max\\\": \\\"5368709120\\\",\\n      \\\"messages_used\\\": 2,\\n      \\\"messages_max\\\": \\\"2684354\\\",\\n      \\\"bytes_used\\\": 1540\\n    },\\n  \\t\\\"folders\\\": [\\n    \\t\\\"INBOX\\\",\\n    \\t\\\"Spam\\\",\\n      \\\"Drafts\\\",\\n  \\t\\t\\\"Trash\\\",\\n  \\t\\t\\\"Sent Items\\\"\\n      ],\\n\\t\\t\\\"mailstore\\\": \\\"mailstore53\\\",\\n\\t\\t\\\"options\\\": {\\n\\t\\t\\t\\\"quota\\\": [ \\n      \\t0,\\n\\t\\t\\t\\t15360 \\n      ],\\n      \\\"workgroup\\\": [\\n    \\t\\t\\\"sales\\\",\\n\\t\\t\\t\\t\\\"staff\\\"\\n      ],\\n      \\\"timezone\\\": [\\n    \\t\\t\\\"Pacific/Wake\\\",\\n    \\t\\t\\\"Pacific/Niue\\\",\\n    \\t\\t\\\"Pacific/Honolulu\\\",\\n    \\t\\t\\\"America/Anchorage\\\",\\n    \\t\\t\\\"America/Vancouver\\\",\\n    \\t\\t\\\"America/Edmonton\\\",\\n    \\t\\t\\\"America/Chicago\\\",\\n    \\t\\t\\\"America/Havana\\\",\\n    \\t\\t\\\"America/Montreal\\\",\\n    \\t\\t\\\"America/Caracas\\\",\\n    \\t\\t\\\"America/Puerto_Rico\\\",\\n    \\t\\t\\\"America/St_Johns\\\",\\n    \\t\\t\\\"America/Buenos_Aires\\\",\\n    \\t\\t\\\"America/Sao_Paulo\\\",\\n    \\t\\t\\\"America/Noronha\\\",\\n    \\t\\t\\\"Atlantic/Azores\\\",\\n    \\t\\t\\\"Europe/London\\\",\\n    \\t\\t\\\"Europe/Amsterdam\\\",\\n    \\t\\t\\\"Africa/Algiers\\\",\\n    \\t\\t\\\"Europe/Helsinki\\\",\\n        \\\"Asia/Jerusalem\\\",\\n  \\t\\t\\t\\\"Africa/Johannesburg\\\",\\n  \\t\\t\\t\\\"Africa/Cairo\\\",\\n  \\t\\t\\t\\\"Asia/Amman\\\",\\n  \\t\\t\\t\\\"Asia/Damascus\\\",\\n  \\t\\t\\t\\\"Europe/Moscow\\\",\\n  \\t\\t\\t\\\"Asia/Tehran\\\",\\n  \\t\\t\\t\\\"Indian/Mauritius\\\",\\n  \\t\\t\\t\\\"Asia/Baku\\\",\\n  \\t\\t\\t\\\"Asia/Kabul\\\",\\n  \\t\\t\\t\\\"Asia/Karachi\\\",\\n  \\t\\t\\t\\\"Asia/Calcutta\\\",\\n  \\t\\t\\t\\\"Asia/Katmandu\\\",\\n  \\t\\t\\t\\\"Asia/Dhaka\\\",\\n  \\t\\t\\t\\\"Asia/Rangoon\\\",\\n  \\t\\t\\t\\\"Asia/Phnom_Penh\\\",\\n  \\t\\t\\t\\\"Asia/Hong_Kong\\\",\\n  \\t\\t\\t\\\"Australia/Perth\\\",\\n  \\t\\t\\t\\\"Asia/Tokyo\\\",\\n  \\t\\t\\t\\\"Australia/Adelaide\\\",\\n  \\t\\t\\t\\\"Australia/Darwin\\\",\\n  \\t\\t\\t\\\"Australia/Brisbane\\\",\\n  \\t\\t\\t\\\"Australia/Melbourne\\\",\\n  \\t\\t\\t\\\"Pacific/Guadalcanal\\\",\\n  \\t\\t\\t\\\"Pacific/Norfolk\\\",\\n  \\t\\t\\t\\\"Pacific/Auckland\\\",\\n  \\t\\t\\t\\\"Pacific/Chatham\\\",\\n  \\t\\t\\t\\\"Pacific/Tongatapu\\\"\\n\\t\\t\\t],\\n\\t\\t\\t\\\"language\\\": [\\n  \\t\\t\\t\\\"el\\\",\\n  \\t\\t\\t\\\"en\\\",\\n  \\t\\t\\t\\\"es\\\",\\n  \\t\\t\\t\\\"fr\\\",\\n  \\t\\t\\t\\\"de\\\",\\n        \\\"it\\\",\\n    \\t\\t\\\"pt_BR\\\",\\n    \\t\\t\\\"nl\\\",\\n    \\t\\t\\\"da\\\",\\n    \\t\\t\\\"no\\\",\\n    \\t\\t\\\"sv\\\"\\n      ], \\n      \\\"brand\\\": [\\n    \\t\\tnull,\\n    \\t\\t\\\"Default Brand\\\",\\n    \\t\\t\\\"Demo Co Brand\\\"\\n      ],\\n  \\t\\t\\\"spamlevel\\\": [\\n    \\t\\tnull,\\n    \\t\\t\\\"Very High\\\",\\n    \\t\\t\\\"High\\\",\\n    \\t\\t\\\"Normal\\\"\\n\\t\\t\\t] \\n\\t\\t},\\n    \\\"addressbook\\\": {\\n  \\t\\t\\\"contacts\\\": 0,\\n  \\t\\t\\\"max\\\": \\\"500\\\",\\n  \\t\\t\\\"groups\\\": 0,\\n  \\t\\t\\\"total\\\": 0\\n\\t\\t},\\n    \\\"createtime\\\": \\\"1321902300\\\",\\n\\t\\t\\\"smtp_limit\\\": {\\n  \\t\\t\\\"free_passes\\\": 10,\\n  \\t\\t\\\"when\\\": {\\n    \\t\\t\\\"1\\\": 0,\\n    \\t\\t\\\"10\\\": 0,\\n    \\t\\t\\\"25\\\": 1322074845,\\n    \\t\\t\\\"50\\\": -1,\\n    \\t\\t\\\"100\\\": -1\\n    \\t\\t\\\"250\\\": -1,\\n        \\\"500\\\": -1 \\n      },\\n    \\t\\\"max\\\": 35,\\n    \\t\\\"free_passes_remaining\\\": 10\\n    \\t\\\"sent\\\": 0\\n  \\t},\\n    \\\"inherit\\\": {\\n\\t\\t\\t\\\"default_password_encoding\\\": \\\"BCRYPT-10\\\", \\n      \\\"smtp_sent_limit\\\": \\\"500\\\",\\n\\t\\t\\t\\\"spamfolder\\\": \\\".Spam\\\",\\n\\t\\t\\t\\\"spamheader\\\": null,\\n    \\t\\\"brand\\\": \\\"bcom1\\\",\\n    \\t\\\"spamtag\\\": null,\\n    \\t\\\"filterdelivery\\\": \\\"local\\\",\\n    \\t\\\"spamlevel\\\": \\\"90\\\"\\n    },\\n  \\t \\\"special_folders\\\": {\\n    \\t\\\"spam\\\": \\\"Spam\\\"\\n  \\t},\\n  \\t\\\"lastlogin\\\": \\\"1374674727\\\",\\n  \\t\\\"status\\\": \\\"active\\\"\\n\\t},\\n\\t\\\"attributes\\\": {\\n  \\t\\\"forward_option_subject_prefix\\\": null, \\n    \\\"max_pab_entries\\\": 500, \\n    \\\"service_smtprelay\\\": \\\"enabled\\\", \\n    \\\"forward_option_restricted\\\": null, \\n    \\\"forward_option_reply_to\\\": null, \\n    \\\"password\\\": null, \\n    \\\"forward_recipients\\\": [], \\n    \\\"autoresponder_option_enddate\\\": null, \\n    \\\"filterdelivery\\\": null,\\n\\t\\t\\\"timezone\\\": \\\"America/Montreal\\\", \\n    \\\"name\\\": \\\"Joseph User\\\",\\n\\t\\t\\\"workgroup\\\": \\\"staff\\\",\\n    \\\"spamtag\\\": null,\\n\\t\\t\\\"service_smtprelay_webmail\\\": \\\"enabled\\\",\\n\\t\\t\\\"title\\\": null,\\n\\t\\t\\\"service_webmail\\\": \\\"enabled\\\",\\n\\t\\t\\\"spamlevel\\\": null,\\n\\t\\t\\\"quota\\\": 5120,\\n\\t\\t\\\"spamfolder\\\": null,\\n\\t\\t\\\"spamheader\\\": null,\\n\\t\\t\\\"brand\\\": null,\\n\\t\\t\\\"delivery_autoresponder\\\": false,\\n\\t\\t\\\"autoresponder\\\": null,\\n\\t\\t\\\"fax\\\": null,\\n\\t\\t\\\"service_smtpin\\\": \\\"enabled\\\",\\n\\t\\t\\\"delivery_forward\\\": false,\\n\\t\\t\\\"autoresponder_option_interval\\\": 1,\\n\\t\\t\\\"reject_spam\\\": null,\\n\\t\\t\\\"delivery_filter\\\": false,\\n\\t\\t\\\"service_imap4\\\": \\\"enabled\\\",\\n\\t\\t\\\"language\\\": \\\"en\\\",\\n\\t\\t\\\"smtp_sent_limit\\\": null,\\n\\t\\t\\\"account\\\": \\\"joe_user@example.com\\\",\\n\\t\\t\\\"service_pop3\\\": \\\"enabled\\\",\\n\\t\\t\\\"phone\\\": null,\\n\\t\\t\\\"macsettings\\\": null,\\n\\t\\t\\\"notes_external\\\": \\\"Joe is a good guy.\\\\nHelp him if you can.\\\", \\n    \\\"aliases\\\": [],\\n\\t\\t\\\"block\\\": [],\\n\\t\\t\\\"allow\\\": [],\\n\\t\\t\\\"delivery_local\\\": true,\\n\\t\\t\\\"sieve\\\": null\\n\\t} \\n}\\n\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]\n## Example 2\n\nShows the result for mrmanager@example.com who is an admin of the workgroup sales.\n\n**Request** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"credentials\\\": {\\n    \\\"user\\\": \\\"admin@example.com\\\",\\n    \\\"password\\\": \\\"xyz\\\"\\n  },\\n  \\\"user\\\": \\\"mrmanager@example.com\\\"\\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  \\\"settable_attributes\\\": [\\n    \\\"aliases\\\",\\n    \\\"allow\\\",\\n    \\\"autoresponder\\\",\\n    \\\"autoresponder_option_enddate\\\",\\n    \\\"autoresponder_option_interval\\\",\\n    \\\"block\\\",\\n    \\\"brand\\\",\\n    \\\"delivery_autoresponder\\\",\\n    \\\"delivery_filter\\\",\\n    \\\"delivery_forward\\\",\\n    \\\"delivery_local\\\",\\n    \\\"fax\\\",\\n    \\\"filterdelivery\\\",\\n    \\\"forward_option_reply_to\\\",\\n    \\\"forward_option_restricted\\\",\\n    \\\"forward_option_subject_prefix\\\",\\n    \\\"forward_recipients\\\",\\n    \\\"language\\\",\\n    \\\"macsettings\\\",\\n    \\\"name\\\",\\n    \\\"notes_external\\\",\\n    \\\"password\\\",\\n    \\\"phone\\\",\\n  \\t\\\"quota\\\",\\n  \\t\\\"reject_spam\\\",\\n  \\t\\\"service_imap4\\\",\\n \\t \\t\\\"service_pop3\\\",\\n  \\t\\\"service_smtpin\\\",\\n  \\t\\\"service_smtprelay\\\",\\n  \\t\\\"service_smtprelay_webmail\\\",\\n  \\t\\\"service_webmail\\\",\\n  \\t\\\"sieve\\\",\\n  \\t\\\"spamfolder\\\",\\n  \\t\\\"spamheader\\\",\\n  \\t\\\"spamlevel\\\",\\n  \\t\\\"spamtag\\\",\\n  \\t\\\"timezone\\\",\\n  \\t\\\"title\\\",\\n  \\t\\\"workgroup\\\"\\n  ],\\n\\t\\\"type\\\": \\\"mailbox\\\",\\n\\t\\\"metadata\\\": {\\n  \\t\\t\\\"roles\\\": {\\n    \\t\\t\\\"workgroup\\\": [\\n      \\t\\t\\\"example.com/sales\\\"\\n     \\t\\t ]\\n\\t\\t\\t}, \\n\\t\\t\\t\\\"quota\\\": {\\n    \\t\\t\\\"bytes_max\\\": \\\"5368709120\\\",\\n    \\t\\t\\\"messages_used\\\": 1,\\n    \\t\\t\\\"messages_max\\\": \\\"2684354\\\",\\n    \\t\\t\\\"bytes_used\\\": 518\\n  \\t\\t},\\n  \\t\\t\\\"folders\\\": [\\n    \\t\\t\\\"INBOX\\\",\\n    \\t\\t\\\"Spam\\\",\\n    \\t\\t\\\"Drafts\\\",\\n    \\t\\t\\\"Trash\\\",\\n  \\t\\t\\t\\\"Sent Items\\\"\\n  \\t\\t],\\n\\t\\t\\t\\\"mailstore\\\": \\\"mailstore01\\\",\\n\\t\\t\\t\\\"options\\\": {\\n\\t\\t\\t\\t\\\"quota\\\": [ \\n    \\t\\t\\t0,\\n\\t\\t\\t\\t\\t15360\\n    \\t\\t],\\n  \\t\\t\\t\\\"workgroup\\\": [\\n    \\t\\t\\t\\\"sales\\\",\\n\\t\\t\\t\\t\\t\\\"staff\\\" \\n  \\t\\t\\t],\\n  \\t\\t\\t\\\"timezone\\\": [\\n    \\t\\t\\t\\\"Pacific/Wake\\\",\\n    \\t\\t\\t\\\"Pacific/Niue\\\",\\n    \\t\\t\\t\\\"Pacific/Honolulu\\\",\\n    \\t\\t\\t\\\"America/Anchorage\\\",\\n    \\t\\t\\t\\\"America/Vancouver\\\",\\n    \\t\\t\\t\\\"America/Edmonton\\\",\\n    \\t\\t\\t\\\"America/Chicago\\\",\\n    \\t\\t\\t\\\"America/Havana\\\",\\n    \\t\\t\\t\\\"America/Montreal\\\",\\n    \\t\\t\\t\\\"America/Caracas\\\",\\n    \\t\\t\\t\\\"America/Puerto_Rico\\\",\\n    \\t\\t\\t\\\"America/St_Johns\\\",\\n    \\t\\t\\t\\\"America/Buenos_Aires\\\",\\n    \\t\\t\\t\\\"America/Sao_Paulo\\\",\\n    \\t\\t\\t\\\"America/Noronha\\\",\\n    \\t\\t\\t\\\"Atlantic/Azores\\\",\\n    \\t\\t\\t\\\"Europe/London\\\",\\n    \\t\\t\\t\\\"Europe/Amsterdam\\\",\\n    \\t\\t\\t\\\"Africa/Algiers\\\",\\n    \\t\\t\\t\\\"Europe/Helsinki\\\",\\n    \\t\\t\\t\\\"Asia/Jerusalem\\\",\\n    \\t\\t\\t\\\"Africa/Johannesburg\\\",\\n  \\t\\t\\t\\t\\\"Africa/Cairo\\\",\\n  \\t\\t\\t\\t\\\"Asia/Amman\\\",\\n  \\t\\t\\t\\t\\\"Asia/Damascus\\\",\\n  \\t\\t\\t\\t\\\"Europe/Moscow\\\",\\n  \\t\\t\\t\\t\\\"Asia/Tehran\\\",\\n  \\t\\t\\t\\t\\\"Indian/Mauritius\\\",\\n  \\t\\t\\t\\t\\\"Asia/Baku\\\",\\n  \\t\\t\\t\\t\\\"Asia/Kabul\\\",\\n  \\t\\t\\t\\t\\\"Asia/Karachi\\\",\\n  \\t\\t\\t\\t\\\"Asia/Calcutta\\\",\\n  \\t\\t\\t\\t\\\"Asia/Katmandu\\\",\\n  \\t\\t\\t\\t\\\"Asia/Dhaka\\\",\\n  \\t\\t\\t\\t\\\"Asia/Rangoon\\\",\\n  \\t\\t\\t\\t\\\"Asia/Phnom_Penh\\\",\\n  \\t\\t\\t\\t\\\"Asia/Hong_Kong\\\",\\n  \\t\\t\\t\\t\\\"Australia/Perth\\\",\\n  \\t\\t\\t\\t\\\"Asia/Tokyo\\\",\\n  \\t\\t\\t\\t\\\"Australia/Adelaide\\\",\\n  \\t\\t\\t\\t\\\"Australia/Darwin\\\",\\n  \\t\\t\\t\\t\\\"Australia/Brisbane\\\",\\n  \\t\\t\\t\\t\\\"Australia/Melbourne\\\",\\n  \\t\\t\\t\\t\\\"Pacific/Guadalcanal\\\",\\n  \\t\\t\\t\\t\\\"Pacific/Norfolk\\\",\\n  \\t\\t\\t\\t\\\"Pacific/Auckland\\\",\\n  \\t\\t\\t\\t\\\"Pacific/Chatham\\\",\\n  \\t\\t\\t\\t\\\"Pacific/Tongatapu\\\"\\n\\t\\t\\t\\t],\\n\\t\\t\\t\\t\\\"language\\\": [\\n  \\t\\t\\t\\t\\\"el\\\",\\n  \\t\\t\\t\\t\\\"en\\\",\\n  \\t\\t\\t\\t\\\"es\\\",\\n  \\t\\t\\t\\t\\\"fr\\\",\\n  \\t\\t\\t\\t\\\"de\\\",\\n  \\t\\t\\t\\t\\\"it\\\",\\n    \\t\\t\\t\\\"pt_BR\\\",\\n    \\t\\t\\t\\\"nl\\\",\\n    \\t\\t\\t\\\"da\\\",\\n    \\t\\t\\t\\\"no\\\",\\n    \\t\\t\\t\\\"sv\\\"\\n  \\t\\t\\t], \\n  \\t\\t\\t\\\"brand\\\": [\\n    \\t\\t\\tnull,\\n    \\t\\t\\t\\\"Default Brand\\\",\\n    \\t\\t\\t\\\"Demo Co Brand\\\"\\n  \\t\\t\\t],\\n  \\t\\t\\t\\\"spamlevel\\\": [\\n    \\t\\t\\tnull,\\n    \\t\\t\\t\\\"Very High\\\",\\n    \\t\\t\\t\\\"High\\\",\\n    \\t\\t\\t\\\"Normal\\\"\\n  \\t\\t\\t] \\n\\t\\t\\t},\\n\\t\\t\\t\\\"addressbook\\\": {\\n  \\t\\t\\t\\\"contacts\\\": 0,\\n  \\t\\t\\t\\\"max\\\": \\\"500\\\",\\n  \\t\\t\\t\\\"groups\\\": 0,\\n  \\t\\t\\t\\\"total\\\": 0\\n\\t\\t\\t},\\n\\t\\t\\t\\\"createtime\\\": \\\"1321902530\\\",\\n\\t\\t\\t\\\"smtp_limit\\\": {\\n  \\t\\t\\t\\\"free_passes\\\": 10,\\n  \\t\\t\\t\\\"when\\\": {\\n    \\t\\t\\t\\\"1\\\": 0,\\n    \\t\\t\\t\\\"10\\\": 0,\\n    \\t\\t\\t\\\"25\\\": 0,\\n    \\t\\t\\t\\\"50\\\": 0,\\n    \\t\\t\\t\\\"100\\\": 0,\\n    \\t\\t\\t\\\"250\\\": 0,\\n    \\t\\t\\t\\\"500\\\": 0,\\n    \\t\\t\\t\\\"750\\\": 0\\n\\t\\t\\t\\t},\\n  \\t\\t\\t\\\"max\\\": 750,\\n  \\t\\t\\t\\\"free_passes_remaining\\\": 9,\\n  \\t\\t\\t\\\"sent\\\": 1\\n\\t\\t\\t},\\n\\t\\t\\t\\\"inherit\\\": {\\n\\t\\t\\t\\t\\\"default_password_encoding\\\": \\\"BCRYPT-10\\\", \\n  \\t\\t\\t\\\"smtp_sent_limit\\\": \\\"500\\\",\\n\\t\\t\\t\\t\\\"spamfolder\\\": \\\".Spam\\\",\\n\\t\\t\\t\\t\\\"spamheader\\\": null,\\n  \\t\\t\\t\\\"brand\\\": \\\"bcom1\\\",\\n  \\t\\t\\t\\\"spamtag\\\": null,\\n  \\t\\t\\t\\\"filterdelivery\\\": \\\"local\\\",\\n  \\t\\t\\t\\\"spamlevel\\\": \\\"90\\\"\\n  \\t\\t},\\n  \\t\\t\\\"special_folders\\\": {\\n    \\t\\t\\\"spam\\\": \\\"Spam\\\"\\n  \\t\\t}\\n\\t\\t},\\n\\t\\t\\\"attributes\\\": {\\n\\t\\t\\t\\\"forward_option_subject_prefix\\\": null, \\n  \\t\\t\\\"max_pab_entries\\\": 500, \\n  \\t\\t\\\"service_smtprelay\\\": \\\"enabled\\\", \\n  \\t\\t\\\"forward_option_restricted\\\": null, \\n  \\t\\t\\\"forward_option_reply_to\\\": null, \\n  \\t\\t\\\"password\\\": null, \\n  \\t\\t\\\"forward_recipients\\\": [], \\n  \\t\\t\\\"autoresponder_option_enddate\\\": null, \\n  \\t\\t\\\"filterdelivery\\\": null,\\n\\t\\t\\t\\\"timezone\\\": \\\"America/Montreal\\\",\\n\\t\\t\\t\\\"name\\\": \\\"Manager\\\",\\n\\t\\t\\t\\\"workgroup\\\": \\\"sales\\\",\\n\\t\\t\\t\\\"spamtag\\\": null, \\n    \\t\\\"service_smtprelay_webmail\\\": \\\"enabled\\\",\\n  \\t\\t\\\"title\\\": \\\"Mr.\\\",\\n\\t\\t\\t\\\"service_webmail\\\": \\\"enabled\\\", \\\"spamlevel\\\": null,\\n\\t\\t\\t\\\"quota\\\": 5120,\\n\\t\\t\\t\\\"spamfolder\\\": null,\\n\\t\\t\\t\\\"spamheader\\\": null,\\n\\t\\t\\t\\\"brand\\\": null, \\n \\t \\t\\t\\\"delivery_autoresponder\\\": false, \\n  \\t\\t\\\"autoresponder\\\": null,\\n\\t\\t\\t\\\"fax\\\": null,\\n\\t\\t\\t\\\"service_smtpin\\\": \\\"enabled\\\", \\n  \\t\\t\\\"delivery_forward\\\": false, \\n  \\t\\t\\\"autoresponder_option_interval\\\": 1, \\n  \\t\\t\\\"reject_spam\\\": null, \\n  \\t\\t\\\"delivery_filter\\\": false, \\n  \\t\\t\\\"service_imap4\\\": \\\"enabled\\\", \\n  \\t\\t\\\"language\\\": \\\"en\\\", \\n  \\t\\t\\\"smtp_sent_limit\\\": null,\\n\\t\\t\\t\\\"account\\\": \\\"mrmanager@example.com\\\", \\n  \\t\\t\\\"service_pop3\\\": \\\"enabled\\\",\\n\\t\\t\\t\\\"phone\\\": null,\\n\\t\\t\\t\\\"macsettings\\\": null, \\n  \\t\\t\\\"notes_external\\\": null,\\n\\t\\t\\t\\\"aliases\\\": [],\\n\\t\\t\\t\\\"block\\\": [],\\n\\t\\t\\t\\\"allow\\\": [],\\n\\t\\t\\t\\\"delivery_local\\\": true,\\n\\t\\t\\t\\\"sieve\\\": null\\n \\t } \\n}\\n\\n\\n\\n    \",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]\n## Example 3\n\nShows the results for a user that does not exist.\n\n**Request** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"credentials\\\": {\\n    \\\"user\\\": \\\"domain_admin@example.com\\\", \\n    \\\"password\\\": \\\"pencil75\\\"\\n  },\\n  \\\"user\\\": \\\"no_such_guy@example.com\\\"\\n}\",\n      \"language\": \"text\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]\n**Response** \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"success\\\": false,\\n  \\\"settable_attributes\\\": [\\n    \\\"aliases\\\",\\n    \\\"allow\\\",\\n    \\\"autoresponder\\\",\\n    \\\"autoresponder_option_enddate\\\",\\n    \\\"autoresponder_option_interval\\\",\\n    \\\"block\\\",\\n    \\\"brand\\\",\\n    \\\"delivery_autoresponder\\\",\\n    \\\"delivery_filter\\\",\\n    \\\"delivery_forward\\\",\\n    \\\"delivery_local\\\",\\n    \\\"fax\\\",\\n    \\\"filterdelivery\\\",\\n    \\\"forward_option_reply_to\\\",\\n    \\\"forward_option_restricted\\\",\\n    \\\"forward_option_subject_prefix\\\",\\n    \\\"forward_recipients\\\",\\n    \\\"language\\\",\\n    \\\"macsettings\\\",\\n    \\\"name\\\",\\n    \\\"notes_external\\\",\\n    \\\"password\\\",\\n    \\\"phone\\\",\\n    \\\"quota\\\",\\n    \\\"reject_spam\\\",\\n    \\\"service_imap4\\\",\\n  \\t\\\"service_pop3\\\",\\n  \\t\\\"service_smtpin\\\",\\n  \\t\\\"service_smtprelay\\\",\\n  \\t\\\"service_smtprelay_webmail\\\",\\n  \\t\\\"service_webmail\\\",\\n  \\t\\\"sieve\\\",\\n  \\t\\\"spamfolder\\\",\\n  \\t\\\"spamheader\\\",\\n  \\t\\\"spamlevel\\\",\\n  \\t\\\"spamtag\\\",\\n  \\t\\\"timezone\\\",\\n  \\t\\\"title\\\",\\n  \\t\\\"workgroup\\\"\\n\\t],\\n\\t\\\"error_number\\\": 2,\\n\\t\\\"error\\\": \\\"The requested object does not exist\\\", \\n  \\\"metadata\\\": {\\n  \\t\\\"options\\\": {\\n    \\t\\\"quota\\\": [\\n        0,\\n\\t\\t\\t\\t15360 \\n      ],\\n    \\t\\\"workgroup\\\": [\\n      \\t\\\"sales\\\",\\n\\t\\t\\t\\t\\\"staff\\\" \\n      ],\\n      \\\"timezone\\\": [\\n      \\t\\\"Pacific/Wake\\\",\\n      \\t\\\"Pacific/Niue\\\",\\n      \\t\\\"Pacific/Honolulu\\\",\\n      \\t\\\"America/Anchorage\\\",\\n      \\t\\\"America/Vancouver\\\",\\n      \\t\\\"America/Edmonton\\\",\\n      \\t\\\"America/Chicago\\\",\\n        \\\"America/Havana\\\",\\n\\t\\t\\t\\t\\\"America/Montreal\\\",\\n\\t\\t\\t\\t\\\"America/Caracas\\\",\\n\\t\\t\\t\\t\\\"America/Puerto_Rico\\\",\\n\\t\\t\\t\\t\\\"America/St_Johns\\\",\\n        \\\"America/Buenos_Aires\\\",\\n        \\\"America/Sao_Paulo\\\",\\n        \\\"America/Noronha\\\",\\n        \\\"Atlantic/Azores\\\",\\n        \\\"Europe/London\\\",\\n        \\\"Europe/Amsterdam\\\",\\n        \\\"Africa/Algiers\\\",\\n        \\\"Europe/Helsinki\\\",\\n        \\\"Asia/Jerusalem\\\",\\n        \\\"Africa/Johannesburg\\\",\\n        \\\"Africa/Cairo\\\",\\n        \\\"Asia/Amman\\\",\\n        \\\"Asia/Damascus\\\",\\n        \\\"Europe/Moscow\\\",\\n        \\\"Asia/Tehran\\\",\\n        \\\"Indian/Mauritius\\\",\\n        \\\"Asia/Baku\\\",\\n        \\\"Asia/Kabul\\\",\\n        \\\"Asia/Karachi\\\",\\n        \\\"Asia/Calcutta\\\",\\n        \\\"Asia/Katmandu\\\",\\n        \\\"Asia/Dhaka\\\",\\n        \\\"Asia/Rangoon\\\",\\n        \\\"Asia/Phnom_Penh\\\",\\n        \\\"Asia/Hong_Kong\\\",\\n        \\\"Australia/Perth\\\",\\n        \\\"Asia/Tokyo\\\",\\n        \\\"Australia/Adelaide\\\",\\n        \\\"Australia/Darwin\\\",\\n        \\\"Australia/Brisbane\\\",\\n        \\\"Australia/Melbourne\\\",\\n    \\t\\t\\\"Pacific/Guadalcanal\\\",\\n    \\t\\t\\\"Pacific/Norfolk\\\",\\n    \\t\\t\\\"Pacific/Auckland\\\",\\n    \\t\\t\\\"Pacific/Chatham\\\",\\n    \\t\\t\\\"Pacific/Tongatapu\\\"\\n       ],\\n  \\t\\t\\\"language\\\": [\\n    \\t\\t\\\"el\\\",\\n    \\t\\t\\\"en\\\",\\n    \\t\\t\\\"es\\\",\\n    \\t\\t\\\"fr\\\",\\n    \\t\\t\\\"de\\\",\\n    \\t\\t\\\"it\\\",\\n    \\t\\t\\\"pt_BR\\\",\\n    \\t\\t\\\"nl\\\",\\n    \\t\\t\\\"da\\\",\\n    \\t\\t\\\"no\\\",\\n    \\t\\t\\\"sv\\\"\\n      ], \\n      \\\"brand\\\": [\\n    \\t\\tnull,\\n    \\t\\t\\\"Default Brand\\\",\\n    \\t\\t\\\"Demo Co Brand\\\"\\n  \\t\\t],\\n  \\t\\t\\\"spamlevel\\\": [\\n    \\t\\tnull,\\n    \\t\\t\\\"Very High\\\",\\n    \\t\\t\\\"High\\\",\\n    \\t\\t\\\"Normal\\\"\\n      ] \\n    },\\n\\t\\t\\\"inherit\\\": {\\n\\t\\t\\t\\\"default_password_encoding\\\": \\\"BCRYPT-10\\\", \\n      \\\"smtp_sent_limit\\\": \\\"500\\\",\\n\\t\\t\\t\\\"spamfolder\\\": \\\".Spam\\\",\\n      \\\"spamheader\\\": null,\\n      \\\"brand\\\": \\\"bcom1\\\",\\n      \\\"spamtag\\\": null,\\n      \\\"filterdelivery\\\": \\\"local\\\",\\n      \\\"spamlevel\\\": \\\"90\\\"\\n    },\\n    \\\"defaults\\\": {\\n\\t\\t\\t\\\"service_imap4\\\": \\\"enabled\\\",\\n\\t\\t\\t\\\"quota\\\": 5120,\\n\\t\\t\\t\\\"language\\\": \\\"en\\\",\\n\\t\\t\\t\\\"timezone\\\": \\\"America/Montreal\\\", \\n      \\\"service_smtprelay\\\": \\\"enabled\\\", \\n      \\\"max_pab_entries\\\": 500,\\n\\t\\t\\t\\\"service_pop3\\\": \\\"enabled\\\",\\n\\t\\t\\t\\\"workgroup\\\": \\\"staff\\\", \\n      \\\"service_smtprelay_webmail\\\": \\\"enabled\\\", \\n      \\\"service_smtpin\\\": \\\"enabled\\\", \\n      \\\"service_webmail\\\": \\\"enabled\\\", \\n      \\\"autoresponder_option_interval\\\": 1\\n\\t\\t} \\n\\t}\\n}\\n\\n        \\n\\n\",\n      \"language\": \"perl\",\n      \"name\": \"  \"\n    }\n  ]\n}\n[/block]","excerpt":"The **get_user** method retrieves the settings and values for a specified user.\n\nIf the specified user does not exist, you can create that user, and so the response contains the **settable_attributes** and **metadata options** that allow a UI client to populate a page of attributes and drop-down options. The response also contains **metadata defaults** that would be assigned to attributes that are not specified in the user creation request.","slug":"get_user","type":"basic","title":"get_user"}

get_user

The **get_user** method retrieves the settings and values for a specified user. If the specified user does not exist, you can create that user, and so the response contains the **settable_attributes** and **metadata options** that allow a UI client to populate a page of attributes and drop-down options. The response also contains **metadata defaults** that would be assigned to attributes that are not specified in the user creation request.

## Syntax **Request** [block:code] { "codes": [ { "code": "{\n <credentials object>,\n \"user\": <mailbox_name>\n}", "language": "perl", "name": " " } ] } [/block] **Response** [block:code] { "codes": [ { "code": "{\n \"success\": true,\n\t\t\"settable_attributes\": [<attribute names>], \n \"type\": mailbox | filter | forward, \n \"metadata\":\n\t\t{\n \"2fa_enabled\": <boolean>\n\t\t\t\t\"roles\": {role name: [<list of objects>]} \n \"quota\": {\n\t\t\t\t\t\t\"bytes_max\": <number of bytes in quota>, \n \"bytes_used\": <number of bytes used>, \n \"messages_max\": <number of messages in quota>, \n \"messages_used\": <number of messages>\n\t\t\t\t},\n\t\t\t\t\"folders\": [list of email folder names] \n\t\t\t\t\"special_folders\": {\n\t\t\t\t\t\t\"spam\": <user's spam folder name> }\n\t\t\t\t\"options\": { <key-value pairs>}, \n\t\t\t\t\"addressbook\": {\n \t\t\"contacts\": <number of contacts in user's webmail address\nbook>,\n\t\t\t\t\t\t\"groups\": <number of groups in user's webmail address\nbook>,\n\t\t\t\t\t\t\"total\": <number of contacts and groups in user's webmail\naddress book>,\n\t\t\t\t\t\t\"max\": <maximum number of contacts and groups allowed>\n },\n \t\"app_passwords\": {\n [\n { \n \"created\": <unix timestamp>,\n \"tag\": <string>\n },\n ...\n ]\n\t\t\t\t\"createtime\": <mailbox creation time>, \n \"smtp_limit\": {\n\t\t\t\t\t\t\"when\": {<time when limits apply>},\n\t\t\t\t\t\t\"max\": <maximum number of messages that user may send in a\n24 hour period>,\n\t\t\t\t\t\t\"sent\": <number of messages sent in the last 24 hour\nperiod>,\n\t\t\t\t\t\t\"free_passes\": <number of free passes available to the\nuser>,\n\t\t\t\t\t\t\"free_passes_remaining\": <number of free passes remaining\nin the 24 hour period>\n\t\t\t\t}\n \"inherit\": {\n \t\t\"brand\": <brand>, \n \t\t\"default_password_encoding\": <encoding type>, \n \t\t\"filterdelivery\": <quarantine | passthrough>, \n \t\t\"smtp_sent_limit\": <number>,\n\t\t\t\t\t\t\"spamfolder\": <folder>, \n \t\t\"spamheader\":<header>,\n\t\t\t\t\t\t\"spamtag\": <tag>,\n\t\t\t\t\t\t\"spamlevel\": <level>\n }\n\t\t\t\t\"lastlogin\": <last login as UNIX epoch time>,\n\t\t\t\t\"status\": active | deleted | suspended | quota | smtplimit\n}\n \"attributes\": { <key-value pairs>}\n}", "language": "perl", "name": " " } ] } [/block] [block:api-header] { "type": "basic", "title": "Request fields for get_user" } [/block] The following fields can be used in the **get_user** method: [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Definition/Value", "0-0": "user", "0-1": "Required", "0-2": "The user's email address." }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Response fields for get_user" } [/block] The following fields may be returned in response to the **get_user** method: [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Description/Value", "0-0": "attributes", "0-1": "Returned if **success = true**", "0-2": "The user's current account settings.\n\nFor more information, see the **Attributes** table below.", "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": "metadata", "3-1": "Always returned", "3-2": "A list of the account settings that can be set for a new user or changed for an existing user.\n\nAllowed values are:\n\n * **2fa_enabled** -- Shows the 2FA enrolment status of the user\n\n * **app_passwords** -- Any existing App Password tags, along with when they were created.\n\n * **addressbook** — The limits and usage of the user's address book. Includes the following:\n \n * **contacts** — The number of contacts in the user's address book.\n \n * **deleted_contacts**: A count of the user’s deleted contacts that may be available for restoration (if the backup exists).\n \n * **groups** — The number of groups in the user's address book.\n \n * **max** — The maximum number of contacts and groups that the user can have in the address book.\n \n * **total** — The total number of contacts and groups that are currently in the user's address book.\n\n * **createtime** — The date that the account was created. \n\n * **defaults** — Returned if the user does not already exist. Indicates the settings that would apply to a new user if not explicitly set. These values are inherited from the domain level. Allowed values are **delivery, language, quota**, and **timezone**. See the **Attributes** table for an explanation of each of these values.\n\n * **folders** — A list of the user's email folders.\n\n * **inherit** — The domain level values that will be assigned if they are not explicity set for this user. Includes the following:\n\n * **brand** — The Webmail brand for this mailbox.\n \n * **default_password_encoding** — The type of password hashing/encoding to be performed when OpenSRS receives an unencrypted password.\n \n * **filterdelivery** — The way in which spam messages are handled.\n \n * **smtp_sent_limit** — The number of messages that the user is allowed to send in a 24 hour period.\n \n * **spamfolder** — The folder into which messages identified as spam will be delivered.\n \n * **spamheader** — The tag that is added to messages that are identified as spam.\n \n * **spamtag** — The value of this field is prepended to the subject of any message that is identified as spam.\n \n * **spamlevel** — The level of aggressiveness set for the spam filter.\n\n * **lastlogin** — The last time the user logged in to the mailbox, expressed as a UNIX epoch time. \n\n **Note**: This is the same data that is available through the stats_snapshot method;; it is not real time data and may be 24-48 hours behind.\n\n * **mailstore** — The storage subsystem that is holding the user's mail.\n \n * **options** — The list of account settings that can be set or changed for a user. Includes all available values for each setting to allow a UI client to populate a page of attributes and drop-down options.\nAllowed settings are **brand, language, quota, spamlevel, timezone**, and **workgroup**. For an explanation of each of these values, see the Attributes table for an explanation of each of these values.\n\n * **quota** — The amount of storage this user is consuming, and their maximum . Includes bytes_max (in bytes), messages_used, messages_max, and bytes_used (in bytes).\n \n * **roles** — The user's admin level, and the objects owned at that level.\n \n * **smtp_limit** — The maximum number of messages that this user is allowed to send in a 24 hour period. Includes the following:\n\n * **free_passes** — The number of messages the user is allowed to send that have been identified as spam or that may contain viruses\n \n * **free_passes_remaining** — The number of free passes remaining in the 24 hour window\n \n * **max** — The maximum number of messages allowed.\n \n * **sent** — The number of messages that were sent in the last 24 hours.\n \n * **when** — The time (in UNIX Epoch time) when the user may send an email to some given number of recipients, or 0 if the user could send to that number of recipients immediately or -1 if the user will never be able to send to that number of recipients (because the number is greater than the user's **max**).\n\n * **special_folders** — The user's spam folder - the folder in which messages that are determined to be spam will be stored.\n \n * **status** — The mailbox status. Allowed values are:\n\n * **active** — The mailbox is currently active.\n \n * **deleted** — The mailbox has been deleted.\n \n * **suspended** — The mailbox has been suspended and the user cannot send or receive mail.\n \n * **quota** — The mailbox is over quota and cannot receive any more mail.\n \n * **smtplimit** — The mailbox is at the smtp limit and the user cannot send any more mail. The smtp limit applies to a sliding 24 hour period, so as time goes by, this status changes.", "4-0": "settable_attributes", "4-1": "Always returned", "4-2": "The list of attributes that can be set for a new user or changed for an existing user.\n\nAllowed values are: \n\n**aliases, allow, autoresponder, autoresponder_option_enddate, autoresponder_option_interval, block, brand, delivery_autoresponder, delivery_filter, delivery_forward, delivery_local, fax, filterdelivery,** **forward_option_reply_to, forward_option_restricted, forward_option_subject_prefix, forward_recipients, language, macsettings, name, notes_external, password, phone, quota, reject_spam, service_imap4, service_pop3,** **service_smtpin, service_smtprelay, service_smtprelay_webmail, service_webmail, sieve, spamfolder,** **apam_header, spamlevel, spamtag, timezone, title, workgroup.** \n\nFor an explanation of each of these attributes, see the **Attributes** table below.", "5-0": "success", "5-1": "Always returned", "5-2": "Indicates whether the request was successful or not. Allowed values are **true** and **false**.", "6-0": "type", "6-1": "Returned if **success = true**", "6-2": "The type of account. Allowed values are **mailbox, filter, forward**, or **alias**." }, "cols": 3, "rows": 7 } [/block] ## Attributes fields The following fields may be returned within the **attributes** array. [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Definition/Value", "0-0": "account", "0-1": "Always returned", "0-2": "The user's complete email address, for example, joe_user@example.com.", "1-0": "aliases", "1-1": "Optional", "1-2": "The list of alternate names for the account, for example, joe@example.com, joey@example.com, juser@example.com. Mail that is sent to an alias address is delivered to the account. The alias address can be used to log in to the account via IMAP4, POP3, Webmail and SMTP\n\nThe maximum number of aliases is 2000.", "2-0": "allow", "2-1": "Optional", "2-2": "A list of email addresses on the user's allow list;; may include wildcards. For example joe_goodguy@bigmail.com and *@example.com. Maximum is 1000 addresses.", "3-0": "autoresponder", "3-1": "Optional", "3-2": "The text of the message that is automatically sent back to senders if **delivery_autoresponder** is set to **true**. Maximum size is 4000 characters.", "4-0": "autoresponder_option_enddate", "4-1": "Optional", "4-2": "The date that the autoresponder expires, expressed in UNIX Epoch time. If not specified, the autoresponder never expires.", "5-0": "autoresponder_option_interval", "5-1": "Optional", "5-2": "The number of hours that must pass before the autoresponder message is sent again to the same address. Must be less than 1095 (3 years) If not set, an interval of 24 hours is used.", "6-0": "block", "6-1": "Optional", "6-2": "A list of email addresses on the user's block list;; may include wildcards. For example, bob_thejerk@othermail.com and *@spammers-inc.com. Messages from these addresses will always be considered to be spam. Maximum is 1000 addresses.", "7-0": "brand", "7-1": "Optional", "7-2": "The Webmail brand for this mailbox. If not specified, the account uses the domain setting.", "8-0": "delivery_autoresponder", "8-1": "Optional", "8-2": "If set to **true**, the configured auto response message is sent to the sender.", "9-0": "delivery_filter", "9-1": "Optional", "9-2": "If set to **true**, messages are scanned and then passed to the domain's filter mx host;; the messages are not stored locally.\n\n**Note**: If **delivery_filter = true**, all other delivery attributes must be **false**.", "10-0": "delivery_forward", "11-0": "delivery_local", "10-1": "Optional", "10-2": "If set to **true**, the message is forwarded to the mailbox's **forward_recipients** list.", "11-1": "Optional", "11-2": "If set to **true**, the message is passed through the mailbox's sieve filters and stored locally." }, "cols": 3, "rows": 12 } [/block] The following combinations of **delivery** attributes may be used: * **delivery_local**—Mail is stored locally. * **delivery_local, delivery_forward**—Mail is stored locally and forwarded. * **delivery_forward**—Mail is forwarded. * **delivery_local, delivery_autoresponder**—Mail is stored locally, automatic reply sent. *** delivery_local, delivery_forward, delivery_autoresponder**—Mail is stored locally and forwarded, automatic reply sent. * **delivery_forward, delivery_autoresponder**—Mail is forwarded, automatic reply sent. * **delivery_filter**—Mail is forwarded to domain-defined mail host. **Note**: No matter which **delivery** setting you specify, incoming messages are always scanned for viruses, and, depending on the mailbox's allow list, scanned for spam. [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Definition/Value", "0-0": "fax", "0-1": "Optional", "0-2": "The fax number for the account owner;; maximum 30 characters.", "1-0": "filterdelivery", "1-1": "Optional", "1-2": "Determines what happens to spam messages:\n\n * **quarantine** — Spam messages are stored locally in the user's spam folder.\n \n * **passthrough** — Spam messages are delivered with the specified **spamtag** and **spamheader**.\n\nIf not defined, the account uses the domain's **filterdelivery** setting.", "2-0": "forward_option_restricted", "2-1": "Optional", "2-2": "If set to **true** and **delivery_forward** is also set to **true**, only messages from addresses on the forward recipients list are forwarded.", "3-0": "forward_option_subject_prefix", "3-1": "Optional", "3-2": "If **delivery_forward** is set to **true**, this string is added to the beginning of the **Subject** line of forwarded messages. String can be up to 128 characters.", "4-0": "forward_option_reply_to", "4-1": "Optional", "4-2": "If **delivery_forward** is set to **true**, this email address is added to the **Reply-To** header of forwarded messages.", "5-0": "forward_recipients", "5-1": "Optional", "5-2": "If **delivery_forward** is set to **true**, incoming messages will be forwarded to this list of addresses. Maximum number of addresses is 1000.", "6-0": "language", "6-1": "Optional", "6-2": "The default language in which the mailbox will be displayed. May be overridden by the user.", "7-0": "macsettings", "7-1": "Optional", "7-2": "A string that contains the user's MAC UI preferences. Only used by the MAC;; not recommended for use by other applications. Maximum 2048 characters.", "8-0": "max_pab_entries", "8-1": "Optional", "8-2": "The maximum number of entries (contacts and groups) that the user can have in their address book.", "9-0": "name", "9-1": "Optional", "9-2": "The name that is used in the From field of email messages. The format is UTF-8 text up to 512 characters.", "10-0": "notes_external", "10-1": "Always returned", "10-2": "Any notes that were added through the **change_user** method. Maximum is 4096 characters. If there are no notes, returns **null**.", "11-0": "password", "11-1": "Optional", "11-2": "Indicates whether a password is set.\n\nIf a password exists, it is displayed as ************\n\nIf there is no password, the returned value is **null**.", "12-0": "phone", "12-1": "Optional", "12-2": "The user's phone number;; maximum 30 characters.", "13-0": "quota", "13-1": "Optional", "13-2": "The maximum amount of storage (in bytes) that the mailbox may use, including mail and file storage.", "14-0": "reject_spam", "14-1": "Optional", "14-2": "Indicates whether spam messages are rejected at the SMTP level. Allowed values are **true** and **false**.", "15-0": "service_imap4", "15-1": "Optional", "15-2": "The current setting for the IMAP4 service (**enabled**, **disabled**, or **suspended**). If **enabled**, the user can log in via IMAP4.", "16-0": "service_pop3", "16-1": "Optional", "16-2": "The current setting for the POP3 service (**enabled**, **disabled**, or **suspended**). If **enabled**, the user can log in via POP3.", "17-0": "service_smtpin", "17-1": "Optional", "17-2": "The current setting for the SMTPIN service (enabled, disabled, or suspended). If enabled, the user can send email.", "18-0": "service_smtprelay", "18-1": "Optional", "18-2": "The current setting for the SMTPRELAY service (**enabled**, **disabled**, or **suspended**).", "19-0": "service_smtprelay_webmail", "19-1": "Optional", "19-2": "The current setting for the SMTPRELAY Webmail service (enabled, disabled, or suspended). If enabled, the user can send email via Webmail.", "20-0": "service_webmail", "20-1": "Optional", "20-2": "The current setting for the Webmail service (**enabled**, **disabled**, or **suspended**). If **enabled**, the user can log in via Webmail." }, "cols": 3, "rows": 21 } [/block] **Note:** If any of the above **service** values (that is, **service_imap4, service_pop3, service_smtpin, service_smtprelay, service_smtprelay_webmail** or **service_webmail**)are set to **suspended**, the service can only be set to **enabled** or **disabled** by an admin of the same or higher level (for example, a domain admin cannot change a service that was suspended by a company admin). [block:parameters] { "data": { "h-0": "Field name", "h-1": "Obligation", "h-2": "Definition/Value", "0-0": "sieve", "0-1": "Optional", "0-2": "The user's sieve filters.", "1-0": "smtp_sent_limit", "1-1": "Optional", "1-2": "The number of messages that the user can send in a 24 hour period. Maximum number is 10,000. If not defined, the domain's **smtp_sent_limit** is used.\n\n**Note**: If the same message is sent to two recipients, it counts as two messages against this limit.", "2-0": "spamfolder", "2-1": "Optional", "2-2": "The folder into which messages identified as spam will be delivered. Maximum 128 characters. Nested folders are separated by the '/' character, for example, \"Archive/Junk/Spam\" If not defined, the mailbox uses the domain's spamfolder setting.", "3-0": "spamheader", "3-1": "Optional", "3-2": "The tag that is added to messages that are identified as spam. Maximum 512 characters.", "4-0": "spamlevel", "4-1": "Optional", "4-2": "The level of aggressiveness set for the spam filter. Valid values are **Normal, High, and Very High**. If not set, the mailbox uses the domain's spamlevel setting.", "5-0": "spamtag", "5-1": "Optional", "5-2": "The value of this field is prepended to the subject of any message that is identified as spam. Maximum 30 characters. If not defined, the mailbox uses the domain's **spamtag** setting.\n\n**Note**: This value is not supported for filteronly accounts.", "6-0": "timezone", "6-1": "Optional", "6-2": "The timezone that the mailbox will use.", "7-0": "title", "7-1": "Optional", "7-2": "The user's job title;; maximum 60 characters.", "8-0": "workgroup", "8-1": "Optional", "8-2": "The workgroup to which the user belongs." }, "cols": 3, "rows": 9 } [/block] [block:api-header] { "type": "basic", "title": "Examples for get_user" } [/block] ## Example 1 Shows the result for joe_user@example.com who is near his smtp_sent limit and currently unable to send a message with 25 recipients. **Request** [block:code] { "codes": [ { "code": "{\n \"credentials\": {\n \"user\": \"admin@example.com\",\n \"password\": \"xyz\"\n },\n \"user\": \"joe_user@example.com\"\n}", "language": "perl", "name": " " } ] } [/block] **Response** [block:code] { "codes": [ { "code": "{\n \"success\": true,\n \"settable_attributes\": [\n \"aliases\",\n \"allow\",\n \"autoresponder\",\n \"autoresponder_option_enddate\",\n \"autoresponder_option_interval\",\n \"block\",\n \"brand\",\n \"delivery_autoresponder\",\n \"delivery_filter\",\n \"delivery_forward\",\n \"delivery_local\",\n \"fax\",\n \"filterdelivery\",\n \"forward_option_reply_to\",\n \"forward_option_restricted\",\n \"forward_option_subject_prefix\",\n \"forward_recipients\",\n \"language\",\n \t\"macsettings\",\n \t\"name\",\n \t\"notes_external\",\n \t\"password\",\n \t\"phone\",\n \t\"quota\",\n \t\"reject_spam\",\n \t\"service_imap4\",\n \t\"service_pop3\",\n \t\"service_smtpin\",\n \t\"service_smtprelay\",\n \t\"service_smtprelay_webmail\",\n \t\"service_webmail\",\n \t\"sieve\",\n \t\"spamfolder\",\n \t\"spamheader\",\n \t\"spamlevel\",\n \t\"spamtag\",\n \t\"timezone\",\n \t\"title\",\n \t\"workgroup\"\n ],\n\t\"type\": \"mailbox\",\n\t\"metadata\": {\n \t\"roles\": {},\n \t\"quota\": {\n \"bytes_max\": \"5368709120\",\n \"messages_used\": 2,\n \"messages_max\": \"2684354\",\n \"bytes_used\": 1540\n },\n \t\"folders\": [\n \t\"INBOX\",\n \t\"Spam\",\n \"Drafts\",\n \t\t\"Trash\",\n \t\t\"Sent Items\"\n ],\n\t\t\"mailstore\": \"mailstore53\",\n\t\t\"options\": {\n\t\t\t\"quota\": [ \n \t0,\n\t\t\t\t15360 \n ],\n \"workgroup\": [\n \t\t\"sales\",\n\t\t\t\t\"staff\"\n ],\n \"timezone\": [\n \t\t\"Pacific/Wake\",\n \t\t\"Pacific/Niue\",\n \t\t\"Pacific/Honolulu\",\n \t\t\"America/Anchorage\",\n \t\t\"America/Vancouver\",\n \t\t\"America/Edmonton\",\n \t\t\"America/Chicago\",\n \t\t\"America/Havana\",\n \t\t\"America/Montreal\",\n \t\t\"America/Caracas\",\n \t\t\"America/Puerto_Rico\",\n \t\t\"America/St_Johns\",\n \t\t\"America/Buenos_Aires\",\n \t\t\"America/Sao_Paulo\",\n \t\t\"America/Noronha\",\n \t\t\"Atlantic/Azores\",\n \t\t\"Europe/London\",\n \t\t\"Europe/Amsterdam\",\n \t\t\"Africa/Algiers\",\n \t\t\"Europe/Helsinki\",\n \"Asia/Jerusalem\",\n \t\t\t\"Africa/Johannesburg\",\n \t\t\t\"Africa/Cairo\",\n \t\t\t\"Asia/Amman\",\n \t\t\t\"Asia/Damascus\",\n \t\t\t\"Europe/Moscow\",\n \t\t\t\"Asia/Tehran\",\n \t\t\t\"Indian/Mauritius\",\n \t\t\t\"Asia/Baku\",\n \t\t\t\"Asia/Kabul\",\n \t\t\t\"Asia/Karachi\",\n \t\t\t\"Asia/Calcutta\",\n \t\t\t\"Asia/Katmandu\",\n \t\t\t\"Asia/Dhaka\",\n \t\t\t\"Asia/Rangoon\",\n \t\t\t\"Asia/Phnom_Penh\",\n \t\t\t\"Asia/Hong_Kong\",\n \t\t\t\"Australia/Perth\",\n \t\t\t\"Asia/Tokyo\",\n \t\t\t\"Australia/Adelaide\",\n \t\t\t\"Australia/Darwin\",\n \t\t\t\"Australia/Brisbane\",\n \t\t\t\"Australia/Melbourne\",\n \t\t\t\"Pacific/Guadalcanal\",\n \t\t\t\"Pacific/Norfolk\",\n \t\t\t\"Pacific/Auckland\",\n \t\t\t\"Pacific/Chatham\",\n \t\t\t\"Pacific/Tongatapu\"\n\t\t\t],\n\t\t\t\"language\": [\n \t\t\t\"el\",\n \t\t\t\"en\",\n \t\t\t\"es\",\n \t\t\t\"fr\",\n \t\t\t\"de\",\n \"it\",\n \t\t\"pt_BR\",\n \t\t\"nl\",\n \t\t\"da\",\n \t\t\"no\",\n \t\t\"sv\"\n ], \n \"brand\": [\n \t\tnull,\n \t\t\"Default Brand\",\n \t\t\"Demo Co Brand\"\n ],\n \t\t\"spamlevel\": [\n \t\tnull,\n \t\t\"Very High\",\n \t\t\"High\",\n \t\t\"Normal\"\n\t\t\t] \n\t\t},\n \"addressbook\": {\n \t\t\"contacts\": 0,\n \t\t\"max\": \"500\",\n \t\t\"groups\": 0,\n \t\t\"total\": 0\n\t\t},\n \"createtime\": \"1321902300\",\n\t\t\"smtp_limit\": {\n \t\t\"free_passes\": 10,\n \t\t\"when\": {\n \t\t\"1\": 0,\n \t\t\"10\": 0,\n \t\t\"25\": 1322074845,\n \t\t\"50\": -1,\n \t\t\"100\": -1\n \t\t\"250\": -1,\n \"500\": -1 \n },\n \t\"max\": 35,\n \t\"free_passes_remaining\": 10\n \t\"sent\": 0\n \t},\n \"inherit\": {\n\t\t\t\"default_password_encoding\": \"BCRYPT-10\", \n \"smtp_sent_limit\": \"500\",\n\t\t\t\"spamfolder\": \".Spam\",\n\t\t\t\"spamheader\": null,\n \t\"brand\": \"bcom1\",\n \t\"spamtag\": null,\n \t\"filterdelivery\": \"local\",\n \t\"spamlevel\": \"90\"\n },\n \t \"special_folders\": {\n \t\"spam\": \"Spam\"\n \t},\n \t\"lastlogin\": \"1374674727\",\n \t\"status\": \"active\"\n\t},\n\t\"attributes\": {\n \t\"forward_option_subject_prefix\": null, \n \"max_pab_entries\": 500, \n \"service_smtprelay\": \"enabled\", \n \"forward_option_restricted\": null, \n \"forward_option_reply_to\": null, \n \"password\": null, \n \"forward_recipients\": [], \n \"autoresponder_option_enddate\": null, \n \"filterdelivery\": null,\n\t\t\"timezone\": \"America/Montreal\", \n \"name\": \"Joseph User\",\n\t\t\"workgroup\": \"staff\",\n \"spamtag\": null,\n\t\t\"service_smtprelay_webmail\": \"enabled\",\n\t\t\"title\": null,\n\t\t\"service_webmail\": \"enabled\",\n\t\t\"spamlevel\": null,\n\t\t\"quota\": 5120,\n\t\t\"spamfolder\": null,\n\t\t\"spamheader\": null,\n\t\t\"brand\": null,\n\t\t\"delivery_autoresponder\": false,\n\t\t\"autoresponder\": null,\n\t\t\"fax\": null,\n\t\t\"service_smtpin\": \"enabled\",\n\t\t\"delivery_forward\": false,\n\t\t\"autoresponder_option_interval\": 1,\n\t\t\"reject_spam\": null,\n\t\t\"delivery_filter\": false,\n\t\t\"service_imap4\": \"enabled\",\n\t\t\"language\": \"en\",\n\t\t\"smtp_sent_limit\": null,\n\t\t\"account\": \"joe_user@example.com\",\n\t\t\"service_pop3\": \"enabled\",\n\t\t\"phone\": null,\n\t\t\"macsettings\": null,\n\t\t\"notes_external\": \"Joe is a good guy.\\nHelp him if you can.\", \n \"aliases\": [],\n\t\t\"block\": [],\n\t\t\"allow\": [],\n\t\t\"delivery_local\": true,\n\t\t\"sieve\": null\n\t} \n}\n", "language": "perl", "name": " " } ] } [/block] ## Example 2 Shows the result for mrmanager@example.com who is an admin of the workgroup sales. **Request** [block:code] { "codes": [ { "code": "{\n \"credentials\": {\n \"user\": \"admin@example.com\",\n \"password\": \"xyz\"\n },\n \"user\": \"mrmanager@example.com\"\n}", "language": "perl", "name": " " } ] } [/block] **Response** [block:code] { "codes": [ { "code": "{\n \"success\": true,\n \"settable_attributes\": [\n \"aliases\",\n \"allow\",\n \"autoresponder\",\n \"autoresponder_option_enddate\",\n \"autoresponder_option_interval\",\n \"block\",\n \"brand\",\n \"delivery_autoresponder\",\n \"delivery_filter\",\n \"delivery_forward\",\n \"delivery_local\",\n \"fax\",\n \"filterdelivery\",\n \"forward_option_reply_to\",\n \"forward_option_restricted\",\n \"forward_option_subject_prefix\",\n \"forward_recipients\",\n \"language\",\n \"macsettings\",\n \"name\",\n \"notes_external\",\n \"password\",\n \"phone\",\n \t\"quota\",\n \t\"reject_spam\",\n \t\"service_imap4\",\n \t \t\"service_pop3\",\n \t\"service_smtpin\",\n \t\"service_smtprelay\",\n \t\"service_smtprelay_webmail\",\n \t\"service_webmail\",\n \t\"sieve\",\n \t\"spamfolder\",\n \t\"spamheader\",\n \t\"spamlevel\",\n \t\"spamtag\",\n \t\"timezone\",\n \t\"title\",\n \t\"workgroup\"\n ],\n\t\"type\": \"mailbox\",\n\t\"metadata\": {\n \t\t\"roles\": {\n \t\t\"workgroup\": [\n \t\t\"example.com/sales\"\n \t\t ]\n\t\t\t}, \n\t\t\t\"quota\": {\n \t\t\"bytes_max\": \"5368709120\",\n \t\t\"messages_used\": 1,\n \t\t\"messages_max\": \"2684354\",\n \t\t\"bytes_used\": 518\n \t\t},\n \t\t\"folders\": [\n \t\t\"INBOX\",\n \t\t\"Spam\",\n \t\t\"Drafts\",\n \t\t\"Trash\",\n \t\t\t\"Sent Items\"\n \t\t],\n\t\t\t\"mailstore\": \"mailstore01\",\n\t\t\t\"options\": {\n\t\t\t\t\"quota\": [ \n \t\t\t0,\n\t\t\t\t\t15360\n \t\t],\n \t\t\t\"workgroup\": [\n \t\t\t\"sales\",\n\t\t\t\t\t\"staff\" \n \t\t\t],\n \t\t\t\"timezone\": [\n \t\t\t\"Pacific/Wake\",\n \t\t\t\"Pacific/Niue\",\n \t\t\t\"Pacific/Honolulu\",\n \t\t\t\"America/Anchorage\",\n \t\t\t\"America/Vancouver\",\n \t\t\t\"America/Edmonton\",\n \t\t\t\"America/Chicago\",\n \t\t\t\"America/Havana\",\n \t\t\t\"America/Montreal\",\n \t\t\t\"America/Caracas\",\n \t\t\t\"America/Puerto_Rico\",\n \t\t\t\"America/St_Johns\",\n \t\t\t\"America/Buenos_Aires\",\n \t\t\t\"America/Sao_Paulo\",\n \t\t\t\"America/Noronha\",\n \t\t\t\"Atlantic/Azores\",\n \t\t\t\"Europe/London\",\n \t\t\t\"Europe/Amsterdam\",\n \t\t\t\"Africa/Algiers\",\n \t\t\t\"Europe/Helsinki\",\n \t\t\t\"Asia/Jerusalem\",\n \t\t\t\"Africa/Johannesburg\",\n \t\t\t\t\"Africa/Cairo\",\n \t\t\t\t\"Asia/Amman\",\n \t\t\t\t\"Asia/Damascus\",\n \t\t\t\t\"Europe/Moscow\",\n \t\t\t\t\"Asia/Tehran\",\n \t\t\t\t\"Indian/Mauritius\",\n \t\t\t\t\"Asia/Baku\",\n \t\t\t\t\"Asia/Kabul\",\n \t\t\t\t\"Asia/Karachi\",\n \t\t\t\t\"Asia/Calcutta\",\n \t\t\t\t\"Asia/Katmandu\",\n \t\t\t\t\"Asia/Dhaka\",\n \t\t\t\t\"Asia/Rangoon\",\n \t\t\t\t\"Asia/Phnom_Penh\",\n \t\t\t\t\"Asia/Hong_Kong\",\n \t\t\t\t\"Australia/Perth\",\n \t\t\t\t\"Asia/Tokyo\",\n \t\t\t\t\"Australia/Adelaide\",\n \t\t\t\t\"Australia/Darwin\",\n \t\t\t\t\"Australia/Brisbane\",\n \t\t\t\t\"Australia/Melbourne\",\n \t\t\t\t\"Pacific/Guadalcanal\",\n \t\t\t\t\"Pacific/Norfolk\",\n \t\t\t\t\"Pacific/Auckland\",\n \t\t\t\t\"Pacific/Chatham\",\n \t\t\t\t\"Pacific/Tongatapu\"\n\t\t\t\t],\n\t\t\t\t\"language\": [\n \t\t\t\t\"el\",\n \t\t\t\t\"en\",\n \t\t\t\t\"es\",\n \t\t\t\t\"fr\",\n \t\t\t\t\"de\",\n \t\t\t\t\"it\",\n \t\t\t\"pt_BR\",\n \t\t\t\"nl\",\n \t\t\t\"da\",\n \t\t\t\"no\",\n \t\t\t\"sv\"\n \t\t\t], \n \t\t\t\"brand\": [\n \t\t\tnull,\n \t\t\t\"Default Brand\",\n \t\t\t\"Demo Co Brand\"\n \t\t\t],\n \t\t\t\"spamlevel\": [\n \t\t\tnull,\n \t\t\t\"Very High\",\n \t\t\t\"High\",\n \t\t\t\"Normal\"\n \t\t\t] \n\t\t\t},\n\t\t\t\"addressbook\": {\n \t\t\t\"contacts\": 0,\n \t\t\t\"max\": \"500\",\n \t\t\t\"groups\": 0,\n \t\t\t\"total\": 0\n\t\t\t},\n\t\t\t\"createtime\": \"1321902530\",\n\t\t\t\"smtp_limit\": {\n \t\t\t\"free_passes\": 10,\n \t\t\t\"when\": {\n \t\t\t\"1\": 0,\n \t\t\t\"10\": 0,\n \t\t\t\"25\": 0,\n \t\t\t\"50\": 0,\n \t\t\t\"100\": 0,\n \t\t\t\"250\": 0,\n \t\t\t\"500\": 0,\n \t\t\t\"750\": 0\n\t\t\t\t},\n \t\t\t\"max\": 750,\n \t\t\t\"free_passes_remaining\": 9,\n \t\t\t\"sent\": 1\n\t\t\t},\n\t\t\t\"inherit\": {\n\t\t\t\t\"default_password_encoding\": \"BCRYPT-10\", \n \t\t\t\"smtp_sent_limit\": \"500\",\n\t\t\t\t\"spamfolder\": \".Spam\",\n\t\t\t\t\"spamheader\": null,\n \t\t\t\"brand\": \"bcom1\",\n \t\t\t\"spamtag\": null,\n \t\t\t\"filterdelivery\": \"local\",\n \t\t\t\"spamlevel\": \"90\"\n \t\t},\n \t\t\"special_folders\": {\n \t\t\"spam\": \"Spam\"\n \t\t}\n\t\t},\n\t\t\"attributes\": {\n\t\t\t\"forward_option_subject_prefix\": null, \n \t\t\"max_pab_entries\": 500, \n \t\t\"service_smtprelay\": \"enabled\", \n \t\t\"forward_option_restricted\": null, \n \t\t\"forward_option_reply_to\": null, \n \t\t\"password\": null, \n \t\t\"forward_recipients\": [], \n \t\t\"autoresponder_option_enddate\": null, \n \t\t\"filterdelivery\": null,\n\t\t\t\"timezone\": \"America/Montreal\",\n\t\t\t\"name\": \"Manager\",\n\t\t\t\"workgroup\": \"sales\",\n\t\t\t\"spamtag\": null, \n \t\"service_smtprelay_webmail\": \"enabled\",\n \t\t\"title\": \"Mr.\",\n\t\t\t\"service_webmail\": \"enabled\", \"spamlevel\": null,\n\t\t\t\"quota\": 5120,\n\t\t\t\"spamfolder\": null,\n\t\t\t\"spamheader\": null,\n\t\t\t\"brand\": null, \n \t \t\t\"delivery_autoresponder\": false, \n \t\t\"autoresponder\": null,\n\t\t\t\"fax\": null,\n\t\t\t\"service_smtpin\": \"enabled\", \n \t\t\"delivery_forward\": false, \n \t\t\"autoresponder_option_interval\": 1, \n \t\t\"reject_spam\": null, \n \t\t\"delivery_filter\": false, \n \t\t\"service_imap4\": \"enabled\", \n \t\t\"language\": \"en\", \n \t\t\"smtp_sent_limit\": null,\n\t\t\t\"account\": \"mrmanager@example.com\", \n \t\t\"service_pop3\": \"enabled\",\n\t\t\t\"phone\": null,\n\t\t\t\"macsettings\": null, \n \t\t\"notes_external\": null,\n\t\t\t\"aliases\": [],\n\t\t\t\"block\": [],\n\t\t\t\"allow\": [],\n\t\t\t\"delivery_local\": true,\n\t\t\t\"sieve\": null\n \t } \n}\n\n\n\n ", "language": "perl", "name": " " } ] } [/block] ## Example 3 Shows the results for a user that does not exist. **Request** [block:code] { "codes": [ { "code": "{\n \"credentials\": {\n \"user\": \"domain_admin@example.com\", \n \"password\": \"pencil75\"\n },\n \"user\": \"no_such_guy@example.com\"\n}", "language": "text", "name": " " } ] } [/block] **Response** [block:code] { "codes": [ { "code": "{\n \"success\": false,\n \"settable_attributes\": [\n \"aliases\",\n \"allow\",\n \"autoresponder\",\n \"autoresponder_option_enddate\",\n \"autoresponder_option_interval\",\n \"block\",\n \"brand\",\n \"delivery_autoresponder\",\n \"delivery_filter\",\n \"delivery_forward\",\n \"delivery_local\",\n \"fax\",\n \"filterdelivery\",\n \"forward_option_reply_to\",\n \"forward_option_restricted\",\n \"forward_option_subject_prefix\",\n \"forward_recipients\",\n \"language\",\n \"macsettings\",\n \"name\",\n \"notes_external\",\n \"password\",\n \"phone\",\n \"quota\",\n \"reject_spam\",\n \"service_imap4\",\n \t\"service_pop3\",\n \t\"service_smtpin\",\n \t\"service_smtprelay\",\n \t\"service_smtprelay_webmail\",\n \t\"service_webmail\",\n \t\"sieve\",\n \t\"spamfolder\",\n \t\"spamheader\",\n \t\"spamlevel\",\n \t\"spamtag\",\n \t\"timezone\",\n \t\"title\",\n \t\"workgroup\"\n\t],\n\t\"error_number\": 2,\n\t\"error\": \"The requested object does not exist\", \n \"metadata\": {\n \t\"options\": {\n \t\"quota\": [\n 0,\n\t\t\t\t15360 \n ],\n \t\"workgroup\": [\n \t\"sales\",\n\t\t\t\t\"staff\" \n ],\n \"timezone\": [\n \t\"Pacific/Wake\",\n \t\"Pacific/Niue\",\n \t\"Pacific/Honolulu\",\n \t\"America/Anchorage\",\n \t\"America/Vancouver\",\n \t\"America/Edmonton\",\n \t\"America/Chicago\",\n \"America/Havana\",\n\t\t\t\t\"America/Montreal\",\n\t\t\t\t\"America/Caracas\",\n\t\t\t\t\"America/Puerto_Rico\",\n\t\t\t\t\"America/St_Johns\",\n \"America/Buenos_Aires\",\n \"America/Sao_Paulo\",\n \"America/Noronha\",\n \"Atlantic/Azores\",\n \"Europe/London\",\n \"Europe/Amsterdam\",\n \"Africa/Algiers\",\n \"Europe/Helsinki\",\n \"Asia/Jerusalem\",\n \"Africa/Johannesburg\",\n \"Africa/Cairo\",\n \"Asia/Amman\",\n \"Asia/Damascus\",\n \"Europe/Moscow\",\n \"Asia/Tehran\",\n \"Indian/Mauritius\",\n \"Asia/Baku\",\n \"Asia/Kabul\",\n \"Asia/Karachi\",\n \"Asia/Calcutta\",\n \"Asia/Katmandu\",\n \"Asia/Dhaka\",\n \"Asia/Rangoon\",\n \"Asia/Phnom_Penh\",\n \"Asia/Hong_Kong\",\n \"Australia/Perth\",\n \"Asia/Tokyo\",\n \"Australia/Adelaide\",\n \"Australia/Darwin\",\n \"Australia/Brisbane\",\n \"Australia/Melbourne\",\n \t\t\"Pacific/Guadalcanal\",\n \t\t\"Pacific/Norfolk\",\n \t\t\"Pacific/Auckland\",\n \t\t\"Pacific/Chatham\",\n \t\t\"Pacific/Tongatapu\"\n ],\n \t\t\"language\": [\n \t\t\"el\",\n \t\t\"en\",\n \t\t\"es\",\n \t\t\"fr\",\n \t\t\"de\",\n \t\t\"it\",\n \t\t\"pt_BR\",\n \t\t\"nl\",\n \t\t\"da\",\n \t\t\"no\",\n \t\t\"sv\"\n ], \n \"brand\": [\n \t\tnull,\n \t\t\"Default Brand\",\n \t\t\"Demo Co Brand\"\n \t\t],\n \t\t\"spamlevel\": [\n \t\tnull,\n \t\t\"Very High\",\n \t\t\"High\",\n \t\t\"Normal\"\n ] \n },\n\t\t\"inherit\": {\n\t\t\t\"default_password_encoding\": \"BCRYPT-10\", \n \"smtp_sent_limit\": \"500\",\n\t\t\t\"spamfolder\": \".Spam\",\n \"spamheader\": null,\n \"brand\": \"bcom1\",\n \"spamtag\": null,\n \"filterdelivery\": \"local\",\n \"spamlevel\": \"90\"\n },\n \"defaults\": {\n\t\t\t\"service_imap4\": \"enabled\",\n\t\t\t\"quota\": 5120,\n\t\t\t\"language\": \"en\",\n\t\t\t\"timezone\": \"America/Montreal\", \n \"service_smtprelay\": \"enabled\", \n \"max_pab_entries\": 500,\n\t\t\t\"service_pop3\": \"enabled\",\n\t\t\t\"workgroup\": \"staff\", \n \"service_smtprelay_webmail\": \"enabled\", \n \"service_smtpin\": \"enabled\", \n \"service_webmail\": \"enabled\", \n \"autoresponder_option_interval\": 1\n\t\t} \n\t}\n}\n\n \n\n", "language": "perl", "name": " " } ] } [/block]