Référence de l’API

E-mails entrants

Créez des adresses et travaillez avec les conversations reçues.

Filtrer les e-mails entrants

POST/domains/:id/inbound/setup

Clé API

Provisionner la réception entrante SES

Requête

curl https://sendhq.cc/api/v1/domains/id_value/inbound/setup \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Réponse 200

{
  "domain": "inbound.example.com",
  "status": "dns_pending",
  "record": {
    "type": "MX",
    "name": "inbound.example.com",
    "value": "10 inbound-smtp.us-east-1.amazonaws.com"
  }
}

POST/domains/:id/inbound/verify

Clé API

Vérifier le routage MX entrant

Requête

curl https://sendhq.cc/api/v1/domains/id_value/inbound/verify \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Réponse 200

{
  "domain": "inbound.example.com",
  "status": "ready",
  "record": {
    "type": "MX"
  }
}

POST/inboxes

Clé API

Créer une adresse de réception

Requête

curl https://sendhq.cc/api/v1/inboxes \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain_id":"dom_…","local_part":"support","name":"Support"}'

Réponse 201

{
  "id": "inb_…",
  "address": "support@inbound.example.com",
  "status": "active"
}

GET/inboxes

Clé API

Lister les adresses de réception

Paramètres de requêtedomain_id

Requête

curl https://sendhq.cc/api/v1/inboxes \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Réponse 200

{
  "data": [],
  "count": 0
}

GET/inboxes/:id

Clé API

Récupérer une adresse de réception

Requête

curl https://sendhq.cc/api/v1/inboxes/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Réponse 200

{
  "id": "inb_…",
  "address": "support@example.com",
  "status": "active"
}

PATCH/inboxes/:id

Clé API

Renommer, activer ou désactiver une boîte de réception

Requête

curl https://sendhq.cc/api/v1/inboxes/id_value \
  -X PATCH \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Customer support","status":"active"}'

Réponse 200

{
  "id": "inb_…",
  "status": "active"
}

PUT/inboxes/:id/forwarding

Clé API

Transférer le courrier reçu par une boîte de réception vers une autre adresse

Définissez `forward_to` sur une adresse e-mail, ou sur null pour désactiver le transfert. L’adresse du propriétaire du compte est activée immédiatement ; toute autre adresse reçoit un e-mail de confirmation (envoyé depuis le domaine vérifié de la boîte de réception et décompté comme un destinataire), et le transfert reste en attente jusqu’à ce que le lien soit confirmé. Les copies transférées sont envoyées depuis l’adresse de la boîte de réception avec l’expéditeur d’origine en Reply-To, respectent les suppressions et les limites de la formule, et ne sont jamais transférées à nouveau.

Requête

curl https://sendhq.cc/api/v1/inboxes/id_value/forwarding \
  -X PUT \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"forward_to":"team@example.net"}'

Réponse 200

{
  "id": "inb_…",
  "address": "support@example.com",
  "forwardTo": "team@example.net",
  "forwardStatus": "pending"
}

DELETE/inboxes/:id

Clé API

Supprimer une boîte de réception en conservant les messages

Requête

curl https://sendhq.cc/api/v1/inboxes/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Réponse 200

{
  "ok": true
}