Riferimento API

Email in entrata

Crea indirizzi e lavora con le conversazioni ricevute.

Filtra email in entrata

POST/domains/:id/inbound/setup

Chiave API

Configura la ricezione in entrata su SES

Richiesta

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

Risposta 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

Chiave API

Verifica l'instradamento MX in entrata

Richiesta

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

Risposta 200

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

POST/inboxes

Chiave API

Crea un indirizzo in entrata

Richiesta

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"}'

Risposta 201

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

GET/inboxes

Chiave API

Elenca gli indirizzi in entrata

Parametri di querydomain_id

Richiesta

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

Risposta 200

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

GET/inboxes/:id

Chiave API

Recupera un indirizzo in entrata

Richiesta

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

Risposta 200

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

PATCH/inboxes/:id

Chiave API

Rinomina, attiva o disattiva una inbox

Richiesta

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"}'

Risposta 200

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

PUT/inboxes/:id/forwarding

Chiave API

Inoltra la posta ricevuta da una inbox a un altro indirizzo

Imposta `forward_to` su un indirizzo email, oppure su null per disattivare l'inoltro. L'indirizzo del titolare dell'account si attiva subito; qualsiasi altro indirizzo riceve un'email di conferma (inviata dal dominio verificato della inbox e conteggiata come un destinatario) e l'inoltro resta in sospeso finché il link non viene confermato. Le copie inoltrate vengono inviate dall'indirizzo della inbox con il mittente originale come Reply-To, rispettano soppressioni e limiti del piano e non vengono mai inoltrate di nuovo.

Richiesta

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"}'

Risposta 200

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

DELETE/inboxes/:id

Chiave API

Elimina una inbox conservandone i messaggi

Richiesta

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

Risposta 200

{
  "ok": true
}