目次
概要
SendGridとは、全世界で利用されているメール配信サービスです。
pottosでメールを送信するためには、SendGridとの連携設定が必要です。
1.SendGridの登録を行う
SendGrid Webサイトよりアカウント新規登録を行います。
・https://sendgrid.kke.co.jp/(日本向けの正規販売代理店)
2.連携設定
2-A.SendGridのAPI Keyの発行(SendGrid管理画面)
pottosにSendGridのメールに関する情報を連携するためのAPI KeyをSendGridにて発行します。
- SendGridの管理画面 [ Settings ] > [ API Keys ]にて「Create API Key」をクリックします。
- 「API Key Name」に任意の名称を入力し、「FullAccess」を選択した状態で、「Create&View」をクリックし、API Keyを発行します。
- 「Create&View」をクリックすると、以下画面が表示され黄枠内に発行されたAPI Keyが表示されます。
発行されたAPI Keyは一度しか表示されません。
必ずこのページでコピーし、安全な場所で保存しておいてください。
2-B.SendGridのVerification keyの発行(SendGrid管理画面)
メールがSendGridから送られたものであることを証明するために、SendGridでVerification keyを発行します。
- SendGridの管理画面 [ Settings ] > [ mail settings ]にて、Webhook Settingsの「Event Webhooks」をクリックします。
- 「Create new webhook」をクリックして、Webhookを作成します。
・Post URL:
https://asia-northeast1-pottos-production.cloudfunctions.net/incomingEmailWebhook
・Actions to be posted:
・Engagement data:「Spam Reports」を除くすべての項目にチェック
・Deliverability Data:「Processed」を除くすべての項目にチェック
・Signature Verification:有効にする
「Save」をクリックして保存します。 - 作成したWebhookの一覧右端にある歯車アイコンより「EDIT」をクリックします。
Signature Verificationの下に表示されているVerification keyをコピーします。
2-C.pottosにAPI key、verification keyの登録(pottos管理画面)
場所:NAVIGATION[ 設定 ] > [外部連携設定 ] > [ SendGrid連携設定 ]
SendGridで発行したAPI keyとverification keyをpottosに連携します。
「SendGrid連携は無効です」をクリックし、有効に切り替えます。
そして、「2-A.SendGridのAPI keyの発行」「2-B.SendGridのverification keyの発行」でコピーした「API Key」と「verificationkey」を枠内に貼り付け、「適用」をクリックします。
これでAPI keyとverification keyの登録は完了です。
2-D.SendGridのSubscription Trackingの設定(SendGrid側)
メール本文の配信停止リンクを有効にするために、SendGridのTracking Settings画面「Subscription Tracking」にて設定をします。
- SendGridの管理画面 [ Settings ] > [ Tracking ]にて「Subscription Tracking」または編集マークをクリックします。
- 「Replacement Tag」に「{{pottos-mail-unsubscribe}}」を入力します。
- 「Setting State」を「ENABLED」にし有効にしてから「Save」をクリックし設定内容を保存します。
これで、Subscription Trackingの基本設定は完了です。
3.送信者設定(SendGrid管理画面)
メールを配信するために必要な送信者情報をSendGridで登録していきます。
- SendGrid管理画面[ Marketing ] > [ Senders ]にて「Create New Sender」をクリックします。
- 次に、Sender(送信者)情報を設定します。(各項目の詳細はSendGridのガイドページを参照してください)
- 設定が完了すると、Sender Management一覧にSenderが追加されます。
- Fromメールアドレスにて認証されると(お使いのメールドメインによって、認証の仕方が変わります)、VERIFIEDにチェックがつきます。
これですべての設定は完了です。
4.連携設定の確認を行う
場所:NAVIGATION[ アクション ] > [ トリガーアクション ] > [ + ]
以上の設定が正しく完了しているか確認を行います。
画面右上の [ + ] をクリックします。
ドロアー内のアクション欄より [ アクションを追加 ] をクリックし、メールを選択します。
※連携確認を行うのみなので、トリガーの設定は不要です。
設定が正しく出来ていない場合、送信者設定の下にエラーメッセージが表示されます。
エラーメッセージが表示された場合は、送信者設定もしくはAPI Key発行の見直しを行ってください。
エラーメッセージの表示がないことを確認できれば、SendGrid設定は全て完了となります。