Mailbox

List mailboxes

Lists all available mailboxes

get/v1/account/{account}/mailboxes

Request

Base URL: https://your-emailengine-host
URL: https://your-emailengine-host/v1/account/{account}/mailboxes
Auth: HTTP bearer

Path parameters

accountstring required

Unique identifier for the email account

Example:user123

Query parameters

countersboolean

If true, then includes message counters in the response

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Response

Returns the account folder tree, including special-use designations and message counts.

Example response

{
  "mailboxes": [
    {
      "path": "Kalender/S&APw-nnip&AOQ-evad",
      "id": "AAMkAGVmMDEzMTM4LTZmYWUtNDdkNC1hMDZiLTU1OGY5OTZhYmY4OAAuAAAAAAAiQ8W967B7TKBjgx9rVEURAQAiIsqMbYjsT5e-T7KzowPTAAAAAAEMAAA=",
      "delimiter": "/",
      "parentPath": "Kalender",
      "name": "Sünnipäevad",
      "listed": true,
      "subscribed": true,
      "specialUse": "\\Sent",
      "specialUseSource": "extension",
      "messages": 120,
      "uidNext": 121,
      "status": {
        "messages": 120,
        "unseen": 120,
        "error": "Mailbox does not exist"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.