送信者 ID
メールは、アカウントが所有するドメインまたはアドレスの送信者 ID から送信されます。Oblic は確認済みの送信者 ID からのみ送信します。追加と削除には identities:manage、一覧取得には identities:manage または email:send の権限を持つキーが必要です。
送信者 ID を追加する
- 名前
identityType- タイプ
- string
- 説明
必須:大文字と小文字を変えずに
DomainまたはEmailを指定します。
- 名前
identity- タイプ
- string
- 説明
必須:
example.comのようなドメイン、またはorders@example.comのようなアドレスです。最大 255 文字です。
- 名前
email- タイプ
- string
- 説明
Domainの場合は必須です。そのドメイン内で送信元として使用するアドレスを指定します。
- 名前
displayName- タイプ
- string
- 説明
必須:送信者名です。最大 255 文字で、
<、>、"、改行は使用できません。
- 名前
replyTo- タイプ
- string
- 説明
返信の送信先アドレスです。
ドメインを追加する
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"
}'
レスポンスには送信者 ID が含まれます。ドメインの場合、payload に公開する DNS レコードが入ります。各レコードは key から value への CNAME で、メールプロバイダーの 3 件の DKIM レコードと、続いて Oblic 独自のレコードが含まれます。
レスポンスの一部
{
"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
}
アカウントに既にある送信者 ID を追加すると、その現在の状態が返されます。値のないフィールドは省略されます。
送信者 ID を確認する
- ドメインは、DNS レコードの公開後に確認されます。DKIM レコードはメールプロバイダーによる署名に使われ、Oblic 独自のレコードはドメインがアカウントの所有物であることを証明します。確認済みドメイン内のすべてのアドレスから送信できます。
- アドレスにはメールプロバイダーからリンクが届き、所有者が開きます。そのドメインもアカウントのドメイン送信者 ID として確認されると送信できます。
- Gmail や Outlook などの公開メールサービスのアドレスは DNS レコードを公開できず、別のプロバイダーによる送信は検証に失敗します。そこで Oblic が自身のサービスを使い、
sendingModeをOBLICとして送信します。送信元は Oblic の送信ドメイン、表示名は「お名前 via Oblic」となり、返信先は元のアドレスです。Oblic は所有者確認リンクをそのアドレスに送信します。有効期間は 72 時間で、開くまでは送信できません。公開メールサービスのドメインをDomainとして追加することはできません。このモードには Oblic の送信ドメインの設定が必要です。未設定の場合、アドレスはPUBLIC_MAILBOX_DOMAINで拒否されます。 - Oblic 自身のドメインは、どのアカウントの送信者 ID にもできません。
verificationStatus は、送信可能になると SUCCESS、それまでは PENDING です。
| 拒否 | cd | 条件 |
|---|---|---|
| 400 | INVALID_IDENTITY | Email の送信者 ID がアドレスではない、またはドメインの email がそのドメインに属していない |
| 400 | PUBLIC_MAILBOX_DOMAIN | gmail.com などの公開メールサービスのドメインを Domain として追加した、または Oblic の送信ドメインが未設定の状態で公開メールの Email を使用した |
| 400 | OBLIC_DOMAIN | Oblic 自身のドメインのいずれか |
| 400 | IDENTITY_LIMIT_REACHED | メールプロバイダーが許可する送信者 ID 数の上限に達している |
| 503 | EMAIL_PROVIDER_UNAVAILABLE | メールプロバイダーに接続できません。再試行してください |
送信者 ID の一覧を取得する
アカウントの送信者 ID が、呼び出し前に確認済みのものを先にして返されます。一覧取得時には確認待ちのものも再確認され、この再確認で確認された ID は同じ応答で SUCCESS として返されます。
送信者 ID を削除する
その送信者 ID からは送信できなくなり、Oblic 経由で送信するアドレスの確認状態も失効します。再追加した場合は再確認が必要です。アカウントにその ID があったかどうかに関係なく、レスポンスは 200 です。