Boîtes e-mail
Créer une boîte
POSThttps://api.temporam.com/v3/mailboxes
| Champ | Type | Requis | Description |
|---|
| domain | string | Oui | Domaine renvoyé par l’endpoint des domaines |
| local_part | string | Non | Partie locale, générée si elle est omise |
- 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"}'
| Champ de réponse | Type | Description |
|---|
| data.id | string | Identifiant de la boîte mail |
| data.address | string | Adresse complète de la boîte mail |
| data.local_part | string | Partie locale de l’adresse |
| data.domain | string | Domaine de l’adresse |
| data.status | string | État de la boîte mail |
| data.created_at | string | Date de création |
| meta.remaining | integer | Quota pertinent restant, lorsqu’il est disponible |
Lister les boîtes
GEThttps://api.temporam.com/v3/mailboxes
| Paramètre | Emplacement | Type | Requis | Défaut | Description |
|---|
| page | query | integer | Non | 1 | Numéro de page |
| limit | query | integer | Non | 20 | Éléments par page |
| Champ de réponse | Type | Description |
|---|
| data | array | Boîtes mail avec les champs indiqués ci-dessus |
| meta.total | integer | Nombre total de boîtes mail |
| meta.page | integer | Page actuelle |
| meta.limit | integer | Éléments par page |
| meta.remaining | integer | Quota pertinent restant, lorsqu’il est disponible |
Consulter une boîte
GEThttps://api.temporam.com/v3/mailboxes/{id}
| Paramètre | Emplacement | Type | Requis | Description |
|---|
| id | path | string | Oui | Identifiant de la boîte mail |
| Champ de réponse | Type | Description |
|---|
| data | object | Détail de la boîte avec les champs indiqués ci-dessus |
| meta.remaining | integer | Quota pertinent restant, lorsqu’il est disponible |
Supprimer une boîte
DELETEhttps://api.temporam.com/v3/mailboxes/{id}
| Paramètre | Emplacement | Type | Requis | Description |
|---|
| id | path | string | Oui | Identifiant de la boîte mail |
| Champ de réponse | Type | Description |
|---|
| data.deleted | boolean | Toujours true lorsque la suppression réussit |
| meta.remaining | integer | Quota pertinent restant, lorsqu’il est disponible |