Mailbox

Create mailbox

Create new mailbox folder

post/v1/account/{account}/mailbox

Request

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

Path parameters

accountstring required

Unique identifier for the email account

Example:user123

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

Request body

pathstring[] required

Mailbox path as an array or a string. If account is namespaced then namespace prefix is added by default.

Example request

{
  "path": [
    "Parent folder",
    "Subfolder"
  ]
}

Response

Returns the created folder and its path.

pathstring required

Full path to mailbox

mailboxIdstring

Mailbox ID (if server has support)

createdboolean

Was the mailbox created

Example response

{
  "path": "Kalender/S&APw-nnip&AOQ-evad",
  "mailboxId": "1439876283476",
  "created": true
}

Changes

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