Mailboxes
Create a mailbox
POSThttps://api.temporam.com/v3/mailboxes
| Field | Type | Required | Description |
|---|
| domain | string | Yes | A domain returned by the Domains endpoint |
| local_part | string | No | Local part; omitted to generate one |
- 1curl -X POST https://api.temporam.com/v3/mailboxes \
- 2 -H "Authorization: Bearer YOUR_API_KEY" \
- 3 -H "Content-Type: application/json" \
- 4 -d '{"domain":"temporam.com","local_part":"demo"}'
| Response field | Type | Description |
|---|
| data.id | string | Mailbox ID |
| data.address | string | Full mailbox address |
| data.local_part | string | Address local part |
| data.domain | string | Address domain |
| data.status | string | Mailbox status |
| data.created_at | string | Creation time |
| meta.remaining | integer | Remaining relevant quota, when available |
List mailboxes
GEThttps://api.temporam.com/v3/mailboxes
| Parameter | Location | Type | Required | Default | Description |
|---|
| page | query | integer | No | 1 | Page number |
| limit | query | integer | No | 20 | Items per page |
| Response field | Type | Description |
|---|
| data | array | Mailboxes using the fields listed above |
| meta.total | integer | Total mailboxes |
| meta.page | integer | Current page |
| meta.limit | integer | Items per page |
| meta.remaining | integer | Remaining relevant quota, when available |
Get a mailbox
GEThttps://api.temporam.com/v3/mailboxes/{id}
| Parameter | Location | Type | Required | Description |
|---|
| id | path | string | Yes | Mailbox ID |
| Response field | Type | Description |
|---|
| data | object | Mailbox details using the fields listed above |
| meta.remaining | integer | Remaining relevant quota, when available |
Delete a mailbox
DELETEhttps://api.temporam.com/v3/mailboxes/{id}
| Parameter | Location | Type | Required | Description |
|---|
| id | path | string | Yes | Mailbox ID |
| Response field | Type | Description |
|---|
| data.deleted | boolean | Always true when deletion succeeds |
| meta.remaining | integer | Remaining relevant quota, when available |