Eメール入門
Vonage Messages API は、チャネルとして電子メールに対応しており、他のメッセージングチャネルで既に使用しているのと同じ API 契約を使用して、トランザクションメールを送信することができます。
「Eメール」チャネルが一般提供開始となりました。ドメインの登録および認証は、Vonageカスタマーダッシュボードからセルフサービスで完了できるようになりました。
前提条件
始める前に、あなたが持っていることを確認してください:
- A Vonage APIアカウント
- Vonage APIダッシュボードのAPIキーとAPIシークレット
- DNSで管理できる送信ドメイン
メール・オンボーディング
Vonage カスタマーダッシュボード上で、ドメインのオンボーディングを直接完了します:
- ログインしてください。 にログインしてください Vonageカスタマーダッシュボード.
- オープンドメイン認証。次のページへ移動してください。 メッセージ > メール > ドメイン認証.
- メールへのアクセスをリクエストしてください。 ダッシュボードからリクエストを送信し、使用する予定のAPIキーを記載してください。SubaccountsのAPIキーを使用する場合は、マスターAPIキーとSubaccountsのAPIキーの両方を記載してください。リクエストの処理が完了し、ドメイン認証オプションが利用可能になった時点で、Vonageから通知が届きます。
- 送信ドメインを追加してください。 [ドメインのVerify] を選択し、ドメイン名を入力して、ユーザーやインフラストラクチャに最も近いリージョン(EU、US、またはAPAC)を選択してください。1つのドメインにつき、Verifyできるリージョンは1つだけです。
- DNSレコードをコピーしてください。 ダッシュボードが、必要なDNSレコードを生成します。各値を、表示されているとおりに正確にコピーしてください。
- DNS設定を更新してください。 ドメインプロバイダーを通じてレコードを追加してください。DNSの反映には最大72時間かかる場合があります。
- 確認を確定してください。 ダッシュボードに戻り、ステータスを確認してください。ステータスが Verify、これでドメインが利用可能になりました。
- ドメインをアプリケーションに関連付けます。 次のセクションの手順に従って、認証済みのドメインをVonage Applications にリンクしてください。
ドメインをVonage Applicationsにリンクする
ドメインの確認が完了したら、受信メールやWebhookイベントが正しくルーティングされるよう、そのドメインをVonage Applicationsに紐付けてください。
ドメインをリンクすると、以下のことが可能になります:
- 受信メールをアプリケーションのWebhookに転送する。
- アプリケーションレベルのインバウンドURLおよびステータスURLの設定。
- Applicationsのスコープに限定された、安全なJWT認証を使用する。
認証済みのドメインをリンクするには:
- Applications. Vonage カスタマーダッシュボードにログインし、「Applications」に移動してください。
- Applicationsを選択してください。 認証済みのドメインと組み合わせて使用したいVonage Applicationsを開きます。
- メッセージを有効にする。 そのアプリケーションで「メッセージ」機能が有効になっていることを確認してください。
- ドメインをリンクしてください。 「ドメインをリンク」を選択し、Verifyされたドメインを選んで、リンクを確認してください。
- Webhookを設定します。 Applicationsの「受信URL」と「ステータスURL」を設定します。
- 設定をVerifyしてください。 ドメインがリンク済みとして表示されていること、および Webhook の URL が正しいことを確認してください。
ドメイン連携ルール: 1つのアプリケーションに複数のドメインを紐付けることはできますが、各ドメインは1つのアプリケーションにしか紐付けることができません。
重要:ドメインが、受信用URLが設定済みのVonage Applicationsに紐付けられていない場合、受信メールは配信されません。
ドメイン認証セットアップ
メールを送信するには、まず送信ドメインの認証を行う必要があります。ドメイン認証を行うことで、配信率が向上するほか、メールボックスプロバイダーが、Vonageがお客様に代わってメールを送信する権限を有していることを確認できるようになります。
ドメインにDNSレコードを追加することで、認証が完了します。これらのレコードにより、以下の機能が利用可能になります:
- Vonageの送信インフラを認証するためのSPF(Sender Policy Framework)。
- DKIM(DomainKeys Identified Mail)を使用して、送信されるメールの本文に暗号署名を行う。
- DMARC(Domain-based Message Authentication, Reporting and Conformance)を用いて、認証失敗時のポリシーおよび報告方法を定義する。
Google、Microsoft、Yahoo! などの主要なメールプロバイダーは、メッセージを配信するか、拒否するか、あるいはフィルタリングするかを判断する際に、これらの標準規格に基づいています。
詳細については、以下を参照してください。 メールの配信率に影響を与える要因.
設定するDNSレコード
Vonageはオンボーディングの際に正確な値を提供します。以下の表は、想定されるレコード構造を示しています:
| 目的 | タイプ | ホスト/キー | 価値 | 説明 |
|---|---|---|---|---|
| AUTH | CNAME | <dkim_key_1>._domainkey.<your_domain> |
<dkim_value_1>._domainkey.xxxx.com |
DKIM キー 1 |
| AUTH | CNAME | <dkim_key_2>._domainkey.<your_domain> |
<dkim_value_2>._domainkey.xxxx.com |
DKIM キー 2 |
| AUTH | CNAME | <dkim_key_3>._domainkey.<your_domain> |
<dkim_value_3>._domainkey.xxxx.com |
DKIM キー 3 |
| SEND | TXT | _dmarc.<your_domain> |
v=DMARC1; p=none; |
DMARCポリシー |
| SEND | TXT | <your_domain> |
v=spf1 include:msg.vonage.com ~all |
SPFポリシー |
認証に関するベストプラクティス
- 各送信ドメインについて、Vonageが提供するすべてのDKIMレコードを設定してください。
- まずはDMARCから始めましょう
p=none監視期間中は、準備が整い次第、より厳格なポリシーを適用してください。 - 以下の方法を使用して、SPFレコードにVonageを追加してください。
include:msg.vonage.com. - すでにSPFレコードがある場合は、既存のエントリを置き換えるのではなく、Vonageのインクルードを末尾に追加してください。
例
- 既存のSPF:
v=spf1 include:example.com ~all - SPFの更新:
v=spf1 include:example.com include:msg.vonage.com ~all
DNSの詳細設定
- クリックしてDNSの追跡設定を開く:Vonageでは、追跡設定用に追加のCNAMEレコードを提供できます。
- カスタム
mail from/ リターンパス:Vonageはカスタムリターンパスの設定に対応しており、追加のMXレコードやTXTレコードを提供する場合があります。
カスタマーダッシュボードから、DNSの詳細設定を選択できます。
最初のメールを送信する
ドメインの確認が完了すれば、Messages API を使用してメールを送信できるようになります。
Vonageアプリケーションの作成
Messages API を使用するには、Messages 機能が有効になっている Vonage アプリケーションが必要です。
- こちらへ アプリケーションの作成 をクリックします。
- アプリケーション名を入力してください。
- クリック 公開鍵と秘密鍵の生成 そして、秘密鍵を安全に保管してください。
- アンダー 能力有効にする メッセージ.
- インバウンドURLおよびステータスURLのWebhookを設定してください。
- クリック 新規アプリケーションの作成.
詳しくは Vonageアプリケーションの作成.
Vonage Applicationsは、Basic Authによる基本的な送信に関しては技術的には任意ですが、受信メールには必須であり、Webhookイベントがアプリケーションレベルで正しくルーティングされるようにするため、すべての本番環境でのユースケースにおいて強く推奨されます。
交換可能な価値を設定する
例では以下の変数を使用していますので、それらを自分の値に置き換えてください:
| 可変 | 説明 |
|---|---|
VONAGE_API_KEY |
APIダッシュボードから取得したVonage APIキー。 |
VONAGE_API_SECRET |
あなたのVonage APIシークレット。 |
VONAGE_APPLICATION_ID |
お客様のVonageアプリケーションID。 |
VONAGE_PRIVATE_KEY |
秘密鍵ファイルへのパス。 |
FROM_EMAIL |
認証済みの送信者メールアドレス。 |
TO_EMAIL |
受信者のメールアドレス。 |
EMAIL_SUBJECT |
メールの件名。 |
JWTの生成
Messages API では JWT 認証が使用されます。API を呼び出す前に、アプリケーション ID と秘密鍵を使用して JWT を生成してください。
テキストメールを送信する
{
"channel": "email",
"from": "sender@example.com",
"to": "recipient@example.com",
"message_type": "text",
"text": "Email body text",
"email": {
"subject": "Email subject"
}
}
成功した場合、APIのレスポンスには以下が含まれます。 message_uuid:
{
"message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
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リクエスト1件あたりのメール本文の最大サイズは100 KBです。本文がこの制限を超えると、リクエストはエラーを返します。
また、Messages API では、ネットワークレベルでペイロードの上限が 200 KB に制限されています。
配送状況の確認
メールを送信した後、Vonageは設定されたステータスURLにメッセージのステータス更新情報を送信します。
| ステータス | 説明 |
|---|---|
submitted |
メールが受け付けられ、配信のためにキューに入れられました。 |
delivered |
そのメールは受信者のメールボックスに届きました。 |
read |
受信者がメールを開封した。 |
rejected |
このメールは配信できませんでした。エラーの詳細をご確認ください。 |
メールの配信率に影響を与える要因
メールの配信成功率とは、メールメッセージが受信者の受信トレイに届く能力のことです。
Delivery そして deliverability は異なります:
- 「配信」とは、受信メールサーバーがメッセージを受け入れたことを意味します。
- 配信成功率とは、メッセージがスパムフォルダや受信拒否フォルダではなく、受信トレイに届くことを指します。
責任分担モデル
メールの配信成功率は、Vonageとお客様の双方の責任です。
| Vonageの責任範囲 | お客様の責任 |
|---|---|
| 信頼性の高いメール配信インフラ | 関連性があり、受信者が期待するメールの送信 |
| 高可用性プラットフォーム | 受信者リストの管理 |
| メッセージ処理 | 送信ドメインの認証 |
| バウンスおよび苦情の処理 | メールのベストプラクティスに従う |
| 抑制リストの管理 | エンゲージメント指標のモニタリング |
ドメイン認証
ドメイン認証は、配信率を左右する最も重要な要素の一つです。
- DKIMはメッセージの内容に署名を行います。
- DMARCでは、認証に失敗した場合の処理方針が定義されています。
- SPFは、承認された送信者を認証します。
これらの基準は、メールボックスプロバイダーが送信者の身元やメッセージの完全性を確認するのに役立ちます。
送信者の評判
メールボックスプロバイダーは、ドメインやIPのレピュテーションを継続的に評価しています。
評判が悪くなると、次のような結果を招く可能性があります:
- スパムフォルダへの振り分け
- 一時的な帯域制限
- メッセージの拒否
- 受信トレイへの表示率が低下
評判は、スパム報告、バウンス率、配信の安定性、ユーザーのエンゲージメント、およびメッセージの質によって左右されます。
ベストプラクティス:
- メッセージを期待している受信者のみに送信してください。
- 送信量の急激な増加は避けてください。
- 定期的に非アクティブな受信者を削除してください。
- 直帰率と苦情率を監視する。
メールコンテンツの品質
メールボックスプロバイダーは、メッセージの内容の質についても評価を行います。
リンク切れ、不審な添付ファイル、画像のみのコンテンツが過多な場合、あるいはデータサイズが大きすぎる場合、配信率に悪影響を及ぼす可能性があります。
ベストプラクティス:
- リンクには信頼できるドメインを使用してください。
- メッセージの内容は、明確で、関連性があり、構成が整っているようにしてください。
- テキストと画像のバランスを適切に保つようにしてください。
- 添付ファイルを検証し、ペイロードのサイズがサポートされている制限範囲内に収まるようにしてください。
受信者のエンゲージメント
メールサービスプロバイダーは、受信トレイへの配信を決定する際、受信者のエンゲージメント指標を活用しています。
ポジティブなシグナルには、開封、クリック、返信、およびスパムフォルダから受信トレイへのメッセージの移動などが含まれます。 ネガティブなシグナルには、苦情、即時削除、および長期にわたる非アクティブ状態などが含まれます。
エンゲージメントが高まると、一般的に送信者の評判が向上します。
バウンス管理
ハードバウンスとソフトバウンスは、送信者のレピュテーションに異なる影響を与えます。
- ハードバウンス:恒久的な配信失敗(例:無効なアドレスや受信者が存在しない場合など)。
- ソフトバウンス:一時的なエラー(例:メールボックスの容量オーバーや一時的なサーバーの問題など)。
Vonageは、バウンスイベントを自動的に処理し、抑制動作を管理することで、恒久的に配信不能な受信者への繰り返し配信試行を削減します。
スパムに関する苦情
スパムに関する苦情は、メールボックスプロバイダーが用いる最も強力なネガティブな信頼シグナルの一つです。
苦情の発生率が高いと、次のような問題が生じる可能性があります:
- 受信トレイへの表示率が低下
- 一時的なブロック
- 評判への恒久的なダメージ
ベストプラクティス:
- オプトインしたユーザーのみに送信してください。
- 貴組織を明確に特定してください。
- 配信停止の手順を簡単かつ分かりやすく表示してください。
- 配信停止の依頼には速やかに対応してください。
Vonageはスパム事象を処理し、影響を受けた受信者への再送信を抑制します。
リストの質
古くなった、無効な、または購入した受信者リストは、配信率を大幅に低下させます。
リストの質の低下がさらに進む:
- ハードバウンス
- スパムに関する苦情
- 購読解除
ベストプラクティス:
- 適切なオプトインの手順を通じてメールアドレスを収集してください。
- 無効な受信者を素早く削除します。
- 使用されていない受信者を定期的に削除してください。
- 決してメールリストを購入してはいけません。
Eメール価格
メールAPIの料金体系はサブスクリプション方式で、複数の料金プランが用意されています。各プランには一定数のメール送信枠が含まれており、それを超える分については1通ごとに超過料金が適用されます。
最新の価格詳細については、以下をご覧ください。 「Email API の料金」ページ または、担当のAccountマネージャーまでお問い合わせください。