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

{
    <credentials object>,
    "user": <mailbox_name>
}

Response

{
    "success": true,
        "settable_attributes": [<attribute names>], 
    "type": mailbox | filter | forward, 
    "metadata":
        {
        "2fa_enabled": <boolean>
                "roles": {role name: [<list of objects>]} 
        "quota": {
                        "bytes_max": <number of bytes in quota>, 
            "bytes_used": <number of bytes used>, 
            "messages_max": <number of messages in quota>, 
            "messages_used": <number of messages>
                },
                "folders": [list of email folder names] 
                "special_folders": {
                        "spam": <user's spam folder name> }
                "options": { <key-value pairs>}, 
                "addressbook": {
                "contacts": <number of contacts in user's webmail address
book>,
                        "groups": <number of groups in user's webmail address
book>,
                        "total": <number of contacts and groups in user's webmail
address book>,
                        "max": <maximum number of contacts and groups allowed>
        },
        "app_passwords": {
          [
            { 
              "created": <unix timestamp>,
              "tag": <string>
            },
            ...
          ]
                "createtime": <mailbox creation time>, 
        "smtp_limit": {
                        "when": {<time when limits apply>},
                        "max": <maximum number of messages that user may send in a
24 hour period>,
                        "sent": <number of messages sent in the last 24 hour
period>,
                        "free_passes": <number of free passes available to the
user>,
                        "free_passes_remaining": <number of free passes remaining
in the 24 hour period>
                }
        "inherit": {
                "brand": <brand>, 
                "default_password_encoding": <encoding type>, 
                "filterdelivery": <quarantine | passthrough>, 
                "smtp_sent_limit": <number>,
                        "spamfolder": <folder>, 
                "spamheader":<header>,
                        "spamtag": <tag>,
                        "spamlevel": <level>
        }
        "last_login": {
          "imap4": <unix timestamp>,
          "oma": <unix timestamp>,
          "pop3": <unix timestamp>,
          "smtpin": <unix timestamp>,
          "smtprelay": <unix timestamp>,
          "webmail": <unix timestamp>
        },
                "lastlogin": <last login as UNIX epoch time>,
                "status": active | deleted | suspended | quota | smtplimit
}
    "attributes": { <key-value pairs>}
}

Request fields for get_user

The following fields can be used in the get_user method:

Field name

Obligation

Definition/Value

user

Required

The user's email address.

Response fields for get_user

The following fields may be returned in response to the get_user method:

Field name

Obligation

Description/Value

attributes

Returned if success = true

The user's current account settings.

For more information, see the Attributes table below.

error

Returned if success = false

A text string that explains the error.

error_number

Returned if success = false

A number that represents the error.

metadata

Always returned

A list of the account settings that can be set for a new user or changed for an existing user.

Allowed values are:

  • 2fa_enabled -- Shows the 2FA enrolment status of the user

  • app_passwords -- Any existing App Password tags, along with when they were created.

  • addressbook — The limits and usage of the user's address book. Includes the following:

  • contacts — The number of contacts in the user's address book.

  • deleted_contacts: A count of the user’s deleted contacts that may be available for restoration (if the backup exists).

  • groups — The number of groups in the user's address book.

  • max — The maximum number of contacts and groups that the user can have in the address book.

  • total — The total number of contacts and groups that are currently in the user's address book.

  • createtime — The date that the account was created.

  • 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.

  • folders — A list of the user's email folders.

  • inherit — The domain level values that will be assigned if they are not explicity set for this user. Includes the following:

  • brand — The Webmail brand for this mailbox.

  • default_password_encoding — The type of password hashing/encoding to be performed when OpenSRS receives an unencrypted password.

  • filterdelivery — The way in which spam messages are handled.

  • smtp_sent_limit — The number of messages that the user is allowed to send in a 24 hour period.

  • spamfolder — The folder into which messages identified as spam will be delivered.

  • spamheader — The tag that is added to messages that are identified as spam.

  • spamtag — The value of this field is prepended to the subject of any message that is identified as spam.

  • spamlevel — The level of aggressiveness set for the spam filter.

  • last_login -- The last time a user accessed services (pop3, imap4, smtprelay, webmail, oma) or received mail (smtp), expressed as a unixtimestamp.

    • lastlogin — The last time the user logged in to the mailbox, expressed as a UNIX epoch time. (deprecated - replace by metadata.last_login)

    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.

    • mailstore — The storage subsystem that is holding the user's mail.

    • 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.
      Allowed 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.

    • 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).

    • roles — The user's admin level, and the objects owned at that level.

    • smtp_limit — The maximum number of messages that this user is allowed to send in a 24 hour period. Includes the following:

    • free_passes — The number of messages the user is allowed to send that have been identified as spam or that may contain viruses

    • free_passes_remaining — The number of free passes remaining in the 24 hour window

    • max — The maximum number of messages allowed.

    • sent — The number of messages that were sent in the last 24 hours.

    • 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).

    • special_folders — The user's spam folder - the folder in which messages that are determined to be spam will be stored.

    • status — The mailbox status. Allowed values are:

    • active — The mailbox is currently active.

    • deleted — The mailbox has been deleted.

    • suspended — The mailbox has been suspended and the user cannot send or receive mail.

    • quota — The mailbox is over quota and cannot receive any more mail.

    • 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.

settable_attributes

Always returned

The list of attributes that can be set for a new user or changed for an existing user.

Allowed values are:

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.

For an explanation of each of these attributes, see the Attributes table below.

success

Always returned

Indicates whether the request was successful or not. Allowed values are true and false.

type

Returned if success = true

The type of account. Allowed values are mailbox, filter, forward, or alias.

Attributes fields

The following fields may be returned within the attributes array.

Field name

Obligation

Definition/Value

account

Always returned

The user's complete email address, for example, [email protected]

aliases

Optional

The list of alternate names for the account, for example, [email protected], [email protected], [email protected] 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

The maximum number of aliases is 2000.

allow

Optional

A list of email addresses on the user's allow list;; may include wildcards. For example [email protected] and *@example.com. Maximum is 1000 addresses.

autoresponder

Optional

The text of the message that is automatically sent back to senders if delivery_autoresponder is set to true. Maximum size is 4000 characters.

autoresponder_option_enddate

Optional

The date that the autoresponder expires, expressed in UNIX Epoch time. If not specified, the autoresponder never expires.

autoresponder_option_interval

Optional

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.

block

Optional

A list of email addresses on the user's block list;; may include wildcards. For example, [email protected] and *@spammers-inc.com. Messages from these addresses will always be considered to be spam. Maximum is 1000 addresses.

brand

Optional

The Webmail brand for this mailbox. If not specified, the account uses the domain setting.

delivery_autoresponder

Optional

If set to true, the configured auto response message is sent to the sender.

delivery_filter

Optional

If set to true, messages are scanned and then passed to the domain's filter mx host;; the messages are not stored locally.

Note: If delivery_filter = true, all other delivery attributes must be false.

delivery_forward

Optional

If set to true, the message is forwarded to the mailbox's forward_recipients list.

delivery_local

Optional

If set to true, the message is passed through the mailbox's sieve filters and stored locally.

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.

Field name

Obligation

Definition/Value

fax

Optional

The fax number for the account owner;; maximum 30 characters.

filterdelivery

Optional

Determines what happens to spam messages:

  • quarantine — Spam messages are stored locally in the user's spam folder.

  • passthrough — Spam messages are delivered with the specified spamtag and spamheader.

If not defined, the account uses the domain's filterdelivery setting.

forward_option_restricted

Optional

If set to true and delivery_forward is also set to true, only messages from addresses on the forward recipients list are forwarded.

forward_option_subject_prefix

Optional

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.

forward_option_reply_to

Optional

If delivery_forward is set to true, this email address is added to the Reply-To header of forwarded messages.

forward_recipients

Optional

If delivery_forward is set to true, incoming messages will be forwarded to this list of addresses. Maximum number of addresses is 1000.

language

Optional

The default language in which the mailbox will be displayed. May be overridden by the user.

macsettings

Optional

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.

max_pab_entries

Optional

The maximum number of entries (contacts and groups) that the user can have in their address book.

name

Optional

The name that is used in the From field of email messages. The format is UTF-8 text up to 512 characters.

notes_external

Always returned

Any notes that were added through the change_user method. Maximum is 4096 characters. If there are no notes, returns null.

password

Optional

Indicates whether a password is set.

If a password exists, it is displayed as ****

If there is no password, the returned value is null.

phone

Optional

The user's phone number;; maximum 30 characters.

quota

Optional

The maximum amount of storage (in bytes) that the mailbox may use, including mail and file storage.

reject_spam

Optional

Indicates whether spam messages are rejected at the SMTP level. Allowed values are true and false.

service_imap4

Optional

The current setting for the IMAP4 service (enabled, disabled, or suspended). If enabled, the user can log in via IMAP4.

service_pop3

Optional

The current setting for the POP3 service (enabled, disabled, or suspended). If enabled, the user can log in via POP3.

service_smtpin

Optional

The current setting for the SMTPIN service (enabled, disabled, or suspended). If enabled, the user can send email.

service_smtprelay

Optional

The current setting for the SMTPRELAY service (enabled, disabled, or suspended).

service_smtprelay_webmail

Optional

The current setting for the SMTPRELAY Webmail service (enabled, disabled, or suspended). If enabled, the user can send email via Webmail.

service_webmail

Optional

The current setting for the Webmail service (enabled, disabled, or suspended). If enabled, the user can log in via Webmail.

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).

Field name

Obligation

Definition/Value

sieve

Optional

The user's sieve filters.

smtp_sent_limit

Optional

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.

Note: If the same message is sent to two recipients, it counts as two messages against this limit.

spamfolder

Optional

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.

spamheader

Optional

The tag that is added to messages that are identified as spam. Maximum 512 characters.

spamlevel

Optional

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.

spamtag

Optional

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.

Note: This value is not supported for filteronly accounts.

timezone

Optional

The timezone that the mailbox will use.

title

Optional

The user's job title;; maximum 60 characters.

workgroup

Optional

The workgroup to which the user belongs.

Examples for get_user

Example 1

Shows the result for [email protected] who is near his smtp_sent limit and currently unable to send a message with 25 recipients.

Request

{
  "credentials": {
    "user": "[email protected]",
    "password": "xyz"
  },
  "user": "[email protected]"
}

Response

{
  "success": true,
  "settable_attributes": [
    "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",
    "spamheader",
    "spamlevel",
    "spamtag",
    "timezone",
    "title",
    "workgroup"
  ],
    "type": "mailbox",
    "metadata": {
    "roles": {},
    "quota": {
      "bytes_max": "5368709120",
      "messages_used": 2,
      "messages_max": "2684354",
      "bytes_used": 1540
    },
    "folders": [
        "INBOX",
        "Spam",
      "Drafts",
        "Trash",
        "Sent Items"
      ],
        "mailstore": "mailstore53",
        "options": {
            "quota": [ 
        0,
                15360 
      ],
      "workgroup": [
            "sales",
                "staff"
      ],
      "timezone": [
            "Pacific/Wake",
            "Pacific/Niue",
            "Pacific/Honolulu",
            "America/Anchorage",
            "America/Vancouver",
            "America/Edmonton",
            "America/Chicago",
            "America/Havana",
            "America/Montreal",
            "America/Caracas",
            "America/Puerto_Rico",
            "America/St_Johns",
            "America/Buenos_Aires",
            "America/Sao_Paulo",
            "America/Noronha",
            "Atlantic/Azores",
            "Europe/London",
            "Europe/Amsterdam",
            "Africa/Algiers",
            "Europe/Helsinki",
        "Asia/Jerusalem",
            "Africa/Johannesburg",
            "Africa/Cairo",
            "Asia/Amman",
            "Asia/Damascus",
            "Europe/Moscow",
            "Asia/Tehran",
            "Indian/Mauritius",
            "Asia/Baku",
            "Asia/Kabul",
            "Asia/Karachi",
            "Asia/Calcutta",
            "Asia/Katmandu",
            "Asia/Dhaka",
            "Asia/Rangoon",
            "Asia/Phnom_Penh",
            "Asia/Hong_Kong",
            "Australia/Perth",
            "Asia/Tokyo",
            "Australia/Adelaide",
            "Australia/Darwin",
            "Australia/Brisbane",
            "Australia/Melbourne",
            "Pacific/Guadalcanal",
            "Pacific/Norfolk",
            "Pacific/Auckland",
            "Pacific/Chatham",
            "Pacific/Tongatapu"
            ],
            "language": [
            "el",
            "en",
            "es",
            "fr",
            "de",
        "it",
            "pt_BR",
            "nl",
            "da",
            "no",
            "sv"
      ], 
      "brand": [
            null,
            "Default Brand",
            "Demo Co Brand"
      ],
        "spamlevel": [
            null,
            "Very High",
            "High",
            "Normal"
            ] 
        },
    "addressbook": {
        "contacts": 0,
        "max": "500",
        "groups": 0,
        "total": 0
        },
    "createtime": "1321902300",
        "smtp_limit": {
        "free_passes": 10,
        "when": {
            "1": 0,
            "10": 0,
            "25": 1322074845,
            "50": -1,
            "100": -1
            "250": -1,
        "500": -1 
      },
        "max": 35,
        "free_passes_remaining": 10
        "sent": 0
    },
    "inherit": {
            "default_password_encoding": "BCRYPT-10", 
      "smtp_sent_limit": "500",
            "spamfolder": ".Spam",
            "spamheader": null,
        "brand": "bcom1",
        "spamtag": null,
        "filterdelivery": "local",
        "spamlevel": "90"
    },
     "special_folders": {
        "spam": "Spam"
    },
    "lastlogin": "1374674727",
    "status": "active"
    },
    "attributes": {
    "forward_option_subject_prefix": null, 
    "max_pab_entries": 500, 
    "service_smtprelay": "enabled", 
    "forward_option_restricted": null, 
    "forward_option_reply_to": null, 
    "password": null, 
    "forward_recipients": [], 
    "autoresponder_option_enddate": null, 
    "filterdelivery": null,
        "timezone": "America/Montreal", 
    "name": "Joseph User",
        "workgroup": "staff",
    "spamtag": null,
        "service_smtprelay_webmail": "enabled",
        "title": null,
        "service_webmail": "enabled",
        "spamlevel": null,
        "quota": 5120,
        "spamfolder": null,
        "spamheader": null,
        "brand": null,
        "delivery_autoresponder": false,
        "autoresponder": null,
        "fax": null,
        "service_smtpin": "enabled",
        "delivery_forward": false,
        "autoresponder_option_interval": 1,
        "reject_spam": null,
        "delivery_filter": false,
        "service_imap4": "enabled",
        "language": "en",
        "smtp_sent_limit": null,
        "account": "[email protected]",
        "service_pop3": "enabled",
        "phone": null,
        "macsettings": null,
        "notes_external": "Joe is a good guy.\nHelp him if you can.", 
    "aliases": [],
        "block": [],
        "allow": [],
        "delivery_local": true,
        "sieve": null
    } 
}

Example 2

Shows the result for [email protected] who is an admin of the workgroup sales.

Request

{
  "credentials": {
    "user": "[email protected]",
    "password": "xyz"
  },
  "user": "[email protected]"
}

Response

{
  "success": true,
  "settable_attributes": [
    "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",
    "spamheader",
    "spamlevel",
    "spamtag",
    "timezone",
    "title",
    "workgroup"
  ],
    "type": "mailbox",
    "metadata": {
        "roles": {
            "workgroup": [
            "example.com/sales"
             ]
            }, 
            "quota": {
            "bytes_max": "5368709120",
            "messages_used": 1,
            "messages_max": "2684354",
            "bytes_used": 518
        },
        "folders": [
            "INBOX",
            "Spam",
            "Drafts",
            "Trash",
            "Sent Items"
        ],
            "mailstore": "mailstore01",
            "options": {
                "quota": [ 
                0,
                    15360
            ],
            "workgroup": [
                "sales",
                    "staff" 
            ],
            "timezone": [
                "Pacific/Wake",
                "Pacific/Niue",
                "Pacific/Honolulu",
                "America/Anchorage",
                "America/Vancouver",
                "America/Edmonton",
                "America/Chicago",
                "America/Havana",
                "America/Montreal",
                "America/Caracas",
                "America/Puerto_Rico",
                "America/St_Johns",
                "America/Buenos_Aires",
                "America/Sao_Paulo",
                "America/Noronha",
                "Atlantic/Azores",
                "Europe/London",
                "Europe/Amsterdam",
                "Africa/Algiers",
                "Europe/Helsinki",
                "Asia/Jerusalem",
                "Africa/Johannesburg",
                "Africa/Cairo",
                "Asia/Amman",
                "Asia/Damascus",
                "Europe/Moscow",
                "Asia/Tehran",
                "Indian/Mauritius",
                "Asia/Baku",
                "Asia/Kabul",
                "Asia/Karachi",
                "Asia/Calcutta",
                "Asia/Katmandu",
                "Asia/Dhaka",
                "Asia/Rangoon",
                "Asia/Phnom_Penh",
                "Asia/Hong_Kong",
                "Australia/Perth",
                "Asia/Tokyo",
                "Australia/Adelaide",
                "Australia/Darwin",
                "Australia/Brisbane",
                "Australia/Melbourne",
                "Pacific/Guadalcanal",
                "Pacific/Norfolk",
                "Pacific/Auckland",
                "Pacific/Chatham",
                "Pacific/Tongatapu"
                ],
                "language": [
                "el",
                "en",
                "es",
                "fr",
                "de",
                "it",
                "pt_BR",
                "nl",
                "da",
                "no",
                "sv"
            ], 
            "brand": [
                null,
                "Default Brand",
                "Demo Co Brand"
            ],
            "spamlevel": [
                null,
                "Very High",
                "High",
                "Normal"
            ] 
            },
            "addressbook": {
            "contacts": 0,
            "max": "500",
            "groups": 0,
            "total": 0
            },
            "createtime": "1321902530",
            "smtp_limit": {
            "free_passes": 10,
            "when": {
                "1": 0,
                "10": 0,
                "25": 0,
                "50": 0,
                "100": 0,
                "250": 0,
                "500": 0,
                "750": 0
                },
            "max": 750,
            "free_passes_remaining": 9,
            "sent": 1
            },
            "inherit": {
                "default_password_encoding": "BCRYPT-10", 
            "smtp_sent_limit": "500",
                "spamfolder": ".Spam",
                "spamheader": null,
            "brand": "bcom1",
            "spamtag": null,
            "filterdelivery": "local",
            "spamlevel": "90"
        },
        "special_folders": {
            "spam": "Spam"
        }
        },
        "attributes": {
            "forward_option_subject_prefix": null, 
        "max_pab_entries": 500, 
        "service_smtprelay": "enabled", 
        "forward_option_restricted": null, 
        "forward_option_reply_to": null, 
        "password": null, 
        "forward_recipients": [], 
        "autoresponder_option_enddate": null, 
        "filterdelivery": null,
            "timezone": "America/Montreal",
            "name": "Manager",
            "workgroup": "sales",
            "spamtag": null, 
        "service_smtprelay_webmail": "enabled",
        "title": "Mr.",
            "service_webmail": "enabled", "spamlevel": null,
            "quota": 5120,
            "spamfolder": null,
            "spamheader": null,
            "brand": null, 
            "delivery_autoresponder": false, 
        "autoresponder": null,
            "fax": null,
            "service_smtpin": "enabled", 
        "delivery_forward": false, 
        "autoresponder_option_interval": 1, 
        "reject_spam": null, 
        "delivery_filter": false, 
        "service_imap4": "enabled", 
        "language": "en", 
        "smtp_sent_limit": null,
            "account": "[email protected]", 
        "service_pop3": "enabled",
            "phone": null,
            "macsettings": null, 
        "notes_external": null,
            "aliases": [],
            "block": [],
            "allow": [],
            "delivery_local": true,
            "sieve": null
     } 
}

Example 3

Shows the results for a user that does not exist.

Request

{
    "credentials": {
    "user": "[email protected]", 
    "password": "pencil75"
  },
  "user": "[email protected]"
}

Response

{
  "success": false,
  "settable_attributes": [
    "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",
    "spamheader",
    "spamlevel",
    "spamtag",
    "timezone",
    "title",
    "workgroup"
    ],
    "error_number": 2,
    "error": "The requested object does not exist", 
  "metadata": {
    "options": {
        "quota": [
        0,
                15360 
      ],
        "workgroup": [
        "sales",
                "staff" 
      ],
      "timezone": [
        "Pacific/Wake",
        "Pacific/Niue",
        "Pacific/Honolulu",
        "America/Anchorage",
        "America/Vancouver",
        "America/Edmonton",
        "America/Chicago",
        "America/Havana",
                "America/Montreal",
                "America/Caracas",
                "America/Puerto_Rico",
                "America/St_Johns",
        "America/Buenos_Aires",
        "America/Sao_Paulo",
        "America/Noronha",
        "Atlantic/Azores",
        "Europe/London",
        "Europe/Amsterdam",
        "Africa/Algiers",
        "Europe/Helsinki",
        "Asia/Jerusalem",
        "Africa/Johannesburg",
        "Africa/Cairo",
        "Asia/Amman",
        "Asia/Damascus",
        "Europe/Moscow",
        "Asia/Tehran",
        "Indian/Mauritius",
        "Asia/Baku",
        "Asia/Kabul",
        "Asia/Karachi",
        "Asia/Calcutta",
        "Asia/Katmandu",
        "Asia/Dhaka",
        "Asia/Rangoon",
        "Asia/Phnom_Penh",
        "Asia/Hong_Kong",
        "Australia/Perth",
        "Asia/Tokyo",
        "Australia/Adelaide",
        "Australia/Darwin",
        "Australia/Brisbane",
        "Australia/Melbourne",
            "Pacific/Guadalcanal",
            "Pacific/Norfolk",
            "Pacific/Auckland",
            "Pacific/Chatham",
            "Pacific/Tongatapu"
       ],
        "language": [
            "el",
            "en",
            "es",
            "fr",
            "de",
            "it",
            "pt_BR",
            "nl",
            "da",
            "no",
            "sv"
      ], 
      "brand": [
            null,
            "Default Brand",
            "Demo Co Brand"
        ],
        "spamlevel": [
            null,
            "Very High",
            "High",
            "Normal"
      ] 
    },
        "inherit": {
            "default_password_encoding": "BCRYPT-10", 
      "smtp_sent_limit": "500",
            "spamfolder": ".Spam",
      "spamheader": null,
      "brand": "bcom1",
      "spamtag": null,
      "filterdelivery": "local",
      "spamlevel": "90"
    },
    "defaults": {
            "service_imap4": "enabled",
            "quota": 5120,
            "language": "en",
            "timezone": "America/Montreal", 
      "service_smtprelay": "enabled", 
      "max_pab_entries": 500,
            "service_pop3": "enabled",
            "workgroup": "staff", 
      "service_smtprelay_webmail": "enabled", 
      "service_smtpin": "enabled", 
      "service_webmail": "enabled", 
      "autoresponder_option_interval": 1
        } 
    }
}