Mailbox

Modify mailbox

Modify an existing mailbox folder (rename or change subscription status)

put/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 folder path to modify

newPathstring[]

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

subscribedboolean

Change mailbox subscription status

Example request

{
  "path": "Folder Name",
  "newPath": [
    "Parent folder",
    "Subfolder"
  ],
  "subscribed": true
}

Response

Returns the renamed folder with its old and new paths.

pathstring

Mailbox folder path

newPathstring

Full path to mailbox if renamed

mailboxIdstring

Mailbox ID after the rename (Gmail API and MS Graph API accounts only)

renamedboolean

Was the mailbox renamed

subscribedboolean

Subscription status after modification

Example response

{
  "path": "Mail",
  "newPath": "Kalender/S&APw-nnip&AOQ-evad",
  "mailboxId": "1439876283476",
  "renamed": true,
  "subscribed": true
}

Changes

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