Mailboxes¶
Since: 12.1.0¶
| Method | Path (Parameters are case-sensitive) | Return Model | Summary | Since |
|---|---|---|---|---|
| GET | /mailboxes | List[Mailbox] | List all mailboxes. | 12.1.0 |
| GET | /mailboxes/{mailboxName} | Mailbox | Retrieve the current state of a mailbox. | 12.1.0 |
| PUT | /mailboxes/{mailboxName} | void | Change the state of a mailbox. (Note - implicitly creates the mailbox). | 12.1.0 |
| DELETE | /mailboxes/{mailboxName} | void | Destroy a mailbox. | 12.1.0 |
list¶
Since: 12.1.0¶
GET /mailboxes¶
List all mailboxes.
get¶
Since: 12.1.0¶
GET /mailboxes/{mailboxName}¶
Retrieve the current state of a mailbox.
Path parameters¶
Parameters are case-sensitive. * mailboxName: string - Name of the mailbox
Error Responses¶
- 404 - Mailbox not found
update¶
Since: 12.1.0¶
PUT /mailboxes/{mailboxName}¶
Change the state of a mailbox. (Note - implicitly creates the mailbox).
Path parameters¶
Parameters are case-sensitive. * mailboxName: string - Name of the mailbox
Query parameters¶
- oldMessages: int - (required) Count of old messages in the mailbox
- newMessages: int - (required) Count of new messages in the mailbox
Error Responses¶
- 404 - Mailbox not found
delete¶
Since: 12.1.0¶
DELETE /mailboxes/{mailboxName}¶
Destroy a mailbox.
Path parameters¶
Parameters are case-sensitive. * mailboxName: string - Name of the mailbox
Error Responses¶
- 404 - Mailbox not found