Client API: Mail: Mailboxes

Name	In	Type	Required
`service_id`	path	integer	yes

Responses

Section titled Create mailbox

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Create mailbox

POST /api/v1/client/mail/{service_id}/mailboxes

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`service_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`domain_id`	integer	yes
`local_part`	string	yes
`password`	string or null	no
`display_name`	string or null	no
`quota_bytes`	integer or null	no

Responses

Section titled Delete mailbox

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Delete mailbox

DELETE /api/v1/client/mail/{service_id}/mailboxes/{account_id}

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Responses

Section titled Mailbox app passwords

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox app passwords

GET /api/v1/client/mail/{service_id}/mailboxes/{account_id}/app-passwords

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Responses

Section titled Mailbox app password create

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox app password create

POST /api/v1/client/mail/{service_id}/mailboxes/{account_id}/app-passwords

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`label`	string	no

Responses

Section titled Mailbox app password delete

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox app password delete

DELETE /api/v1/client/mail/{service_id}/mailboxes/{account_id}/app-passwords/{credential_id}

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`credential_id`	path	string	yes
`service_id`	path	integer	yes

Responses

Section titled Mailbox enabled

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox enabled

PATCH /api/v1/client/mail/{service_id}/mailboxes/{account_id}/enabled

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`enabled`	boolean	yes

Responses

Section titled Mailbox imports

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox imports

GET /api/v1/client/mail/{service_id}/mailboxes/{account_id}/imports

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Responses

Section titled Mailbox import start

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox import start

POST /api/v1/client/mail/{service_id}/mailboxes/{account_id}/imports

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`preset`	string	no
`host`	string or null	no
`username`	string	yes
`password`	string	yes
`folders`	array of string	no
`since`	string (date) or null	no
`until`	string (date) or null	no
`trash`	boolean	no
`spam`	boolean	no

Responses

Section titled Mailbox import sign in

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox import sign in

POST /api/v1/client/mail/{service_id}/mailboxes/{account_id}/imports/oauth

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`provider`	string, one of `google`, `microsoft`	yes
`return_path`	string or null	no
`since`	string (date) or null	no
`until`	string (date) or null	no
`trash`	boolean	no
`spam`	boolean	no

Responses

Section titled Mailbox import upload

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox import upload

POST /api/v1/client/mail/{service_id}/mailboxes/{account_id}/imports/upload

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Request body

multipart/form-data (required)

Field	Type	Required
`file`	string (binary)	yes
`kind`	string	no
`folder`	string	no
`cpanel_mailbox`	string	no
`trash`	boolean	no
`spam`	boolean	no

Responses

Section titled Mailbox import steer

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox import steer

POST /api/v1/client/mail/{service_id}/mailboxes/{account_id}/imports/{import_id}/{action}

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`import_id`	path	integer	yes
`action`	path	string, one of `pause`, `resume`, `cancel`	yes
`service_id`	path	integer	yes

Responses

Section titled Mailbox password

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox password

POST /api/v1/client/mail/{service_id}/mailboxes/{account_id}/password

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`password`	string or null	no

Responses

Section titled Mailbox quota

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox quota

PATCH /api/v1/client/mail/{service_id}/mailboxes/{account_id}/quota

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`quota_bytes`	integer	yes

Responses

Section titled Mailbox sessions

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox sessions

GET /api/v1/client/mail/{service_id}/mailboxes/{account_id}/sessions

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Responses

Section titled Mailbox sessions end

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox sessions end

DELETE /api/v1/client/mail/{service_id}/mailboxes/{account_id}/sessions

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Responses

Section titled Mailbox session end

Status	Meaning
`204`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox session end

DELETE /api/v1/client/mail/{service_id}/mailboxes/{account_id}/sessions/{session_id}

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`session_id`	path	string	yes
`service_id`	path	integer	yes

Responses

Section titled Mailbox totp enable

Status	Meaning
`204`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox totp enable

POST /api/v1/client/mail/{service_id}/mailboxes/{account_id}/totp

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Responses

Section titled Mailbox totp disable

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Mailbox totp disable

DELETE /api/v1/client/mail/{service_id}/mailboxes/{account_id}/totp

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`account_id`	path	integer	yes
`service_id`	path	integer	yes

Responses