Absenderidentitäten
E-Mails werden mit einer Absenderidentität des Kontos versendet: einer eigenen Domain oder einer Adresse. Oblic sendet nur mit verifizierten Identitäten. Zum Hinzufügen und Löschen ist ein Schlüssel mit identities:manage erforderlich; zum Auflisten identities:manage oder email:send.
Eine Identität hinzufügen
- Name
identityType- Typ
- string
- Beschreibung
Erforderlich:
DomainoderEmail, genau in dieser Schreibweise.
- Name
identity- Typ
- string
- Beschreibung
Erforderlich: die Domain, etwa
example.com, oder die Adresse, etwaorders@example.com, mit höchstens 255 Zeichen.
- Name
email- Typ
- string
- Beschreibung
Bei
Domainerforderlich: eine Adresse dieser Domain, mit der die Identität sendet.
- Name
displayName- Typ
- string
- Beschreibung
Erforderlich: der Absendername mit höchstens 255 Zeichen, ohne
<,>,"oder Zeilenumbruch.
- Name
replyTo- Typ
- string
- Beschreibung
Die Adresse, an die Antworten gehen.
Eine Domain hinzufügen
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"
}'
Die Antwort enthält die Identität. Bei einer Domain enthält payload die zu veröffentlichenden DNS-Einträge, jeweils einen CNAME von key zu value: die drei DKIM-Einträge des E-Mail-Anbieters, danach den Eintrag von Oblic.
Auszug aus der Antwort
{
"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
}
Das Hinzufügen einer bereits im Konto vorhandenen Identität gibt deren aktuellen Zustand zurück. Felder ohne Wert werden ausgelassen.
Die Identität verifizieren
- Eine Domain wird verifiziert, sobald ihre DNS-Einträge veröffentlicht sind: Mit den DKIM-Einträgen signiert der Anbieter die E-Mails; Oblics eigener Eintrag weist die Zugehörigkeit der Domain zum Konto nach. Jede Adresse einer verifizierten Domain kann senden.
- Eine Adresse erhält vom E-Mail-Anbieter einen Link, den ihr Inhaber öffnet. Sie kann senden, sobald auch ihre Domain als Domainidentität des Kontos verifiziert ist.
- Eine Adresse bei einem öffentlichen Maildienst, etwa Gmail oder Outlook, kann keine Einträge veröffentlichen. Über einen anderen Anbieter versendete Nachrichten bestehen dessen Prüfungen nicht. Oblic versendet sie daher über seinen eigenen Dienst mit
sendingModegleichOBLIC: von Oblics Versanddomain unter „Ihr Name via Oblic“, mit Antworten an die ursprüngliche Adresse. Oblic sendet einen 72 Stunden gültigen Link zur Bestätigung der Inhaberschaft an die Adresse; vor dessen Öffnung kann die Identität nicht senden. Die Domain eines öffentlichen Maildienstes kann nicht alsDomainhinzugefügt werden. Dieser Modus erfordert eine konfigurierte Versanddomain von Oblic; andernfalls wird die Adresse mitPUBLIC_MAILBOX_DOMAINabgelehnt. - Oblics eigene Domains können keinem Konto als Identität gehören.
verificationStatus ist SUCCESS, sobald eine Identität senden kann, und bis dahin PENDING.
| Abgelehnt | cd | Wann |
|---|---|---|
| 400 | INVALID_IDENTITY | Eine Email-Identität ist keine E-Mail-Adresse, oder die email einer Domain gehört nicht zu dieser Domain |
| 400 | PUBLIC_MAILBOX_DOMAIN | Die Domain eines öffentlichen Maildienstes, etwa gmail.com, als Domain, oder eine öffentliche Email-Identität ohne konfigurierte Oblic-Versanddomain |
| 400 | OBLIC_DOMAIN | Eine von Oblics eigenen Domains |
| 400 | IDENTITY_LIMIT_REACHED | Der E-Mail-Anbieter hat seine zulässige Anzahl an Identitäten erreicht |
| 503 | EMAIL_PROVIDER_UNAVAILABLE | Der E-Mail-Anbieter ist nicht erreichbar; versuchen Sie es erneut |
Identitäten auflisten
Die Identitäten des Kontos, die vor dem Aufruf verifizierten zuerst. Beim Auflisten werden auch ausstehende Identitäten erneut geprüft. Eine Identität, die diese Prüfung verifiziert, wird in derselben Antwort als SUCCESS aufgeführt.
Eine Identität löschen
Die Identität kann nicht mehr senden. Bei einer über Oblic versendeten Adresse endet auch ihre Bestätigung: Nach erneutem Hinzufügen muss sie erneut bestätigt werden. Die Antwort ist 200, unabhängig davon, ob das Konto die Identität hatte.