Identità del mittente
Un'email viene inviata da una delle identità del mittente dell'account: un dominio di sua proprietà o un indirizzo. Oblic invia solo da identità verificate. Aggiungere ed eliminare identità richiede una chiave con identities:manage; elencarle richiede identities:manage o email:send.
Aggiungere un'identità
- Nome
identityType- Tipo
- string
- Descrizione
Obbligatorio:
DomainoEmail, rispettando maiuscole e minuscole.
- Nome
identity- Tipo
- string
- Descrizione
Obbligatorio: il dominio, per esempio
example.com, o l'indirizzo, per esempioorders@example.com, fino a 255 caratteri.
- Nome
email- Tipo
- string
- Descrizione
Per un
Domain, obbligatorio: un indirizzo di quel dominio usato dall'identità per inviare.
- Nome
displayName- Tipo
- string
- Descrizione
Obbligatorio: il nome del mittente, fino a 255 caratteri, senza
<,>,"o interruzioni di riga.
- Nome
replyTo- Tipo
- string
- Descrizione
L'indirizzo a cui vengono inviate le risposte.
Aggiungere un dominio
curl -X POST https://api.oblic.app/external/v1/identities \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"identityType": "Domain",
"identity": "example.com",
"email": "orders@example.com",
"displayName": "Example Store"
}'
La risposta contiene l'identità. Per un dominio, payload contiene i record DNS da pubblicare, ciascuno un CNAME da key a value: i tre record DKIM del provider email, seguiti da quello di Oblic.
Parte della risposta
{
"status": "success",
"data": {
"id": "OEM000R7ZM4Q2VXH00",
"email": "orders@example.com",
"displayName": "Example Store",
"domain": "example.com",
"verificationStatus": "PENDING",
"sendingMode": "OWN",
"payload": [
{ "key": "6gbrjpgwjskckoa6a5zn6fwqkn67xbtw._domainkey.example.com", "value": "6gbrjpgwjskckoa6a5zn6fwqkn67xbtw.dkim.amazonses.com" },
{ "key": "pwmp4w2fqavhvhqfsxe3ch7mhc6y3kzj._domainkey.example.com", "value": "pwmp4w2fqavhvhqfsxe3ch7mhc6y3kzj.dkim.amazonses.com" },
{ "key": "y2xbgbc34rt5t5yjzu4mktqq3e4zrl7n._domainkey.example.com", "value": "y2xbgbc34rt5t5yjzu4mktqq3e4zrl7n.dkim.amazonses.com" },
{ "key": "_9f86d081884c4d659a2feaa0c55ad015.example.com", "value": "2c26b46b68ffc68ff99b453c1d304134.qwertyui.validation.oblic.app" }
]
},
"errors": null
}
Aggiungere un'identità già presente nell'account restituisce il suo stato attuale. Un campo privo di valore viene omesso.
Verificare l'identità
- Un dominio viene verificato quando i suoi record DNS sono pubblicati: i record DKIM consentono al provider di firmare le email, mentre il record di Oblic dimostra che il dominio appartiene all'account. Qualsiasi indirizzo di un dominio verificato può inviare.
- Un indirizzo riceve dal provider email un link che il proprietario deve aprire. Può inviare quando anche il suo dominio è verificato come identità di dominio dell'account.
- Un indirizzo presso un servizio di posta pubblico, come Gmail o Outlook, non può pubblicare record e le email inviate tramite un altro provider non superano i controlli. Oblic le invia quindi tramite il proprio servizio, con
sendingModeuguale aOBLIC: dal dominio di invio di Oblic, come «Il tuo nome via Oblic», con le risposte dirette all'indirizzo originale. Oblic invia a quell'indirizzo un link di conferma della proprietà valido per 72 ore; prima dell'apertura, l'identità non può inviare. Il dominio di un servizio di posta pubblico non può essere aggiunto comeDomain. Questa modalità richiede che il dominio di invio di Oblic sia configurato; altrimenti l'indirizzo viene rifiutato conPUBLIC_MAILBOX_DOMAIN. - I domini propri di Oblic non possono essere identità di alcun account.
verificationStatus è SUCCESS quando l'identità può inviare e PENDING fino a quel momento.
| Rifiuto | cd | Quando |
|---|---|---|
| 400 | INVALID_IDENTITY | Un'identità Email che non è un indirizzo, oppure il campo email di un dominio che non appartiene a quel dominio |
| 400 | PUBLIC_MAILBOX_DOMAIN | Un dominio di posta pubblico, come gmail.com, aggiunto come Domain, oppure un'identità Email pubblica quando il dominio di invio di Oblic non è configurato |
| 400 | OBLIC_DOMAIN | Uno dei domini propri di Oblic |
| 400 | IDENTITY_LIMIT_REACHED | Il provider email ha raggiunto il numero massimo di identità consentito |
| 503 | EMAIL_PROVIDER_UNAVAILABLE | Il provider email non è raggiungibile; riprova |
Elencare le identità
Le identità dell'account, a partire da quelle verificate prima della chiamata. L'elenco ricontrolla anche quelle in attesa, e un'identità verificata da questo controllo risulta SUCCESS già nella stessa risposta.
Eliminare un'identità
L'identità smette di inviare e, per un indirizzo inviato tramite Oblic, termina anche la conferma: se viene aggiunto di nuovo, deve essere confermato di nuovo. La risposta è 200, indipendentemente dal fatto che l'account avesse l'identità.