Eメール入門
Vonage Messages APIはEメールをチャネルとしてサポートし、他のメッセージング・チャネルに既に使用しているのと同じAPIコントラクトを使用してトランザクションEメールを送信できます。単一の統合で、スタックに別のEメールプロバイダを追加することなく、すべてのアウトバウンドコミュニケーションを管理できます。
このガイドでは、Messages APIを使って初めてEメールを送信する際に必要なことを説明します。
Eメールチャネルは現在ベータ版です。この段階では、オンボーディングはアカウントマネージャによって管理されます。
前提条件
始める前に、以下を確認してください:
- A Vonage APIアカウント
- Vonage API Dashboardから入手可能なAPIキーとAPIシークレット
- Verifyされた送信ドメイン。 ドメイン認証セットアップ 以下
- Eメールチャネルへのベータアクセス - Account Managerにお問い合わせください。
メール・オンボーディング
参加するには、以下の手順に従ってください:
- 以下の情報をアカウント・マネージャーにお知らせください:
- Vonage APIキー
- メールを送信するカスタムドメイン(例:yourdomain.com
- ご希望のドメイン認証地域米国、EU、またはAPAC
ベータ期間中は、1つのリージョンでのみドメインを検証できます。ユーザーまたはインフラストラクチャに最も近い地域を選択してください。
- アカウント・マネージャーが情報をプロダクト・マネージャーに伝え、プロダクト・マネージャーがオンボーディング・プロセスを開始します。
- Vonageは、ドメインのDNS設定に追加する必要があるDNSレコードのセットを提供します。以下を参照してください。 ドメイン認証セットアップ レコードの全リストと各レコードが何をするのかについては、こちらをご覧ください。
- DNSレコードを更新したら、Account Managerに確認してください。DNSの確認には最大72時間かかります。
- DNSレコードを速やかに追加してください。伝播には最大72時間かかることがあります。予想以上に時間がかかる場合は、ドメインの新しいDNSレコードを生成することをお勧めします。
- 認証が完了すると、VonageからAccount Managerに通知され、Messages API経由でEメールの送信を開始できます。
ドメインが地域でVerifyされたら、すべてのメールリクエストに対応する地域のエンドポイントを使用する必要があります。異なる地域のエンドポイントに送信されたリクエストは失敗します。
| 地域 | エンドポイント |
|---|---|
| EU | https://api-eu.nexmo.com/v1/messages/ |
| US | https://api-us.nexmo.com/v1/messages/ |
| APAC | https://api-ap.nexmo.com/v1/messages/ |
ドメイン認証セットアップ
電子メールを送信する前に、送信ドメインを認証する必要があります。ドメイン認証は、電子メールの配信性を向上させ、メールボックスプロバイダがVerifyがお客様に代わって電子メールを送信する権限があることを確認できるようにします。
認証は、ドメインのDNS設定にDNSレコードを追加することで完了します。これらのレコードにより、以下のことが可能になります:
- SPF (Sender Policy Framework) - Vonageの送信インフラがお客様のドメインに代わって送信することを承認します。
- DKIM(DomainKeys Identified Mail) - 送信メールに暗号的に署名することで、受信サーバーはコンテンツが改ざんされていないことを確認できる。
- DMARC(Domain-based Message Authentication, Reporting & Conformance) - 認証失敗の処理方針を定義し、報告を提供する。
グーグル、マイクロソフト、ヤフーなどの主要メールボックス・プロバイダは、メールを配信すべきか、拒否すべきか、スパムとしてマークすべきかを判断するために、これらのメカニズムに依存している。
設定するDNSレコード
Vonageはオンボーディング中に正確なDNSレコード値を提供します。以下の表は、追加する必要がある各レコードの構造と種類を示しています:
| タイプ | レコードの種類 | ホスト/キー | 価値 | 説明 |
|---|---|---|---|---|
| AUTH | CNAME | <dkim_key_1>._domainkey.<your_domain> | <dkim_value_1>.dkim.xxxx.com | DKIMレコード |
| AUTH | CNAME | <dkim_key_2>._domainkey.<your_domain> | <dkim_value_2>.dkim.xxxx.com | DKIMレコード |
| AUTH | CNAME | <dkim_key_3>._domainkey.<your_domain> | <dkim_value_3>.dkim.xxxx.com | DKIMレコード |
| SEND | TXT | _dmarc.<your_domain> | v=DMARC1; p=none; | DMARCポリシー |
| SEND | TXT | <your_domain> | v=spf1 include:.xxxx.com ~all | SPFレコード |
最初のメールを送信する
ドメインが検証されると、Messages API経由でメールを送信する準備が整います。
Vonageアプリケーションの作成
Messages APIを使用するには、Messages機能を有効にしたVonageアプリケーションが必要です。アプリケーションはWebhook設定と認証情報を保持します。
- Vonage DashboardのCreate an Applicationに進みます。
- アプリケーションに名前を付けましょう。
- クリック 公開鍵と秘密鍵の生成.秘密鍵ファイルは自動的にダウンロードされますが、再ダウンロードはできませんので、安全に保管してください。
- アンダー 能力メッセージを有効にする。
- Inbound URLとStatus URLをアプリケーションのWebhookエンドポイントに設定します。これらがまだない場合は、プレースホルダURLを使用し、後で更新することができます。
- クリック 新規アプリケーションの作成.
詳しくは Vonageアプリケーションの作成.
交換可能な価値を設定する
本ガイドのコード例では、以下の変数を使用しています。例を実行する前に、それぞれを実際の値に置き換えてください。
| 可変 | 説明 |
|---|---|
VONAGE_API_KEY | APIダッシュボードにあるVonage APIキー。 |
VONAGE_API_SECRET | あなたのVonage APIシークレット。 |
VONAGE_APPLICATION_ID | VonageアプリケーションのID。 |
VONAGE_PRIVATE_KEY | 秘密鍵ファイルへのパス。 |
FROM_EMAIL | あなたのVerify送信者メールアドレス(例. support@yourdomain.com). |
TO_EMAIL | 受信者のEメールアドレス。 |
EMAIL_SUBJECT | メールの件名 |
JWTの生成
Messages APIは認証にJSON Web Tokens(JWT)を使用します。アプリケーションIDと秘密鍵を使用してJWTを生成します。
テキストメールを送信する
プレーンテキストの電子メールを送信するには、次のリクエストを使用します:
{
"channel": "email",
"from": "sender@example.com",
"to": "recipient@example.com",
"message_type": "text",
"text": "Email body text",
"email": {
"subject": "Email subject"
}
}
リクエストに成功すると、次のようなレスポンスが返される。 message_uuid:
{
"message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
HTMLメールの送信
HTMLコンテンツを含むメールを送信するには message_type への "html" をクリックし、本文フィールドにHTMLマークアップを入力してください:
{
"channel": "email",
"from": "sender@example.com",
"to": "recipient@example.com",
"message_type": "html",
"html": {
"body": "<p>Email body html</p>"
},
"email": {
"subject": "Email subject"
}
}
Eメールのサイズ制限
メール本文の最大サイズは、APIリクエストあたり100KBです。メール本文がこの制限を超える場合、リクエストはエラーを返します。メール本文のサイズが制限内に収まるようにしてください。
メール本文の制限に加えて、Messages APIではペイロード・サイズの合計に200KBというネットワーク・レベルの制限が適用されます。信頼性の高いメッセージ配信のために、これらの制限に留意してください。
配送状況の確認
電子メールの送信後、Vonage は Vonage Application で設定されたステータス URL に配信ステータスの更新を送信します。各更新は message_uuid とステータス・フィールドがある。
Eメールチャネルの主なステータスは以下の通り:
| ステータス | 説明 |
|---|---|
submitted | メールが受け付けられ、配信のためにキューに入れられました。 |
delivered | メールは受信者のメールボックスに正常に配信されました。 |
read | 受信者がメールを開封した。 |
rejected | メールが配信されませんでした。詳細はエラーコードを確認してください。 |
Eメール価格
Email APIの価格はサブスクリプションベースで、6つのティアからお選びいただけます。各階層には一定のEメール数が含まれます。プランに含まれるEメールを使用した後は、Eメールごとに超過料金が発生します。現在の料金の詳細については、アカウントマネージャーにお問い合わせください。