Mailboxes
Method |
Path<br>h5. Parameters are case-sensitive |
Return Model |
Summary |
|---|
GET |
List all mailboxes. |
||
GET |
Retrieve the current state of a mailbox. |
||
PUT |
void |
Change the state of a mailbox. (Note - implicitly creates the mailbox). |
|
DELETE |
void |
Destroy a mailbox. |
list: GET /mailboxes
List all mailboxes.
get: 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: 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: DELETE /mailboxes/{mailboxName}
Destroy a mailbox.
Path parameters
Parameters are case-sensitive.
- mailboxName: string - Name of the mailbox
Error Responses
- 404 - Mailbox not found