SendGrid Email を使用してメール認証を設定する

SendGrid メールサービスのための公式 Logto コネクター。

ヒント:

このガイドは、Logto コネクターについての基本的な理解があることを前提としています。未経験の方は、コネクター ガイドを参照して始めてください。

はじめに

SendGrid（すなわち Twilio SendGrid）は、トランザクションおよびマーケティングメールのための顧客コミュニケーションプラットフォームです。そのメール送信機能を使用して、認証コード を送信できます。

SendGrid アカウントの登録

SendGrid のウェブサイト で新しいアカウントを作成してください。すでにアカウントをお持ちの場合は、このステップをスキップできます。

送信者の認証

SendGrid コンソールページ にアクセスし、SendGrid アカウントでサインインします。

送信者とは、認証コードメールの送信元アドレスを示します。SendGrid のメールサーバー経由でメールを送信するには、少なくとも 1 つの送信者を認証する必要があります。

SendGrid コンソールページ から、サイドバーの「Settings」→「Sender Authentication」へ進みます。

ドメイン認証 (Domain Authentication) は推奨されますが、必須ではありません。「Authenticate Your Domain」カードの「Get started」をクリックし、案内に従って送信者を SendGrid にリンクし認証できます。

パネル内の「Verify a Single Sender」ボタンをクリックすると、送信者を作成するために必要な情報を入力するフォームが表示されます。案内に従い、すべての項目を入力して「Create」ボタンを押してください。

シングル送信者が作成されると、認証用リンクが記載されたメールが送信者のメールアドレスに届きます。メールボックスを確認し、認証メールを見つけて、メール内のリンクをクリックしてシングル送信者の認証を完了してください。これで、認証済みの送信者を使って SendGrid コネクター経由でメールを送信できるようになります。

API キーの作成

SendGrid コンソールページ から始め、「Settings」→「API Keys」へ進みます。

API Keys ページ右上の「Create API Key」をクリックします。API キーの名前を入力し、用途に応じて「API Key Permission」をカスタマイズしてください。メール送信にこの API キーを使用するには、グローバルな Full Access または Mail Send へのフルアクセスを持つ Restricted Access が必要です。

Create API Key プロセスが完了すると、API キーが画面に表示されます。この API キーはこのタイミングでしか確認できないため、安全な場所に保存してください。

コネクターの設定

「API キーの作成」セクションで作成した API キーを apiKey フィールドに入力します。

送信者の From Address と Nickname を fromEmail および fromName フィールドに入力します。送信者の詳細は "Sender Management" ページ で確認できます。fromName は任意項目ですので、省略可能です。

用途に応じて複数の SendGrid メールコネクターテンプレートを追加できます。以下は単一テンプレートを追加する例です：

• メールのタイトルとなる subject フィールドを入力します。
• 任意の文字列内容を content フィールドに入力します。ランダム認証コード用の {{code}} プレースホルダーを忘れずに残してください。
• 用途に応じて usageType フィールドに Register、SignIn、ForgotPassword、Generic のいずれかを入力します。
• 内容の種類に応じて type フィールドに text/plain または text/html を入力します。

すべてのユーザーフローを有効にするには、Register、SignIn、ForgotPassword、Generic の usageType を持つテンプレートが必要です。

以下は SendGrid コネクターテンプレート JSON の例です。

[
  {
    "subject": "<register-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (register template)>",
    "usageType": "Register",
    "type": "text/plain",
  },
  {
    "subject": "<sign-in-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (sign-in template)>",
    "usageType": "SignIn",
    "type": "text/plain",
  },
  {
    "subject": "<forgot-password-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (forgot-password template)>",
    "usageType": "ForgotPassword",
    "type": "text/plain",
  },
  {
    "subject": "<generic-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (generic template)>",
    "usageType": "Generic",
    "type": "text/plain",
  },
]

SendGrid メールコネクターのテスト

メールアドレスを入力し、「Send」をクリックすることで、「Save and Done」前に設定が機能するかどうかを確認できます。

以上です。サインアップ / サインインでコネクターを有効化 するのを忘れずに。

設定タイプ

名前	型
apiKey	string
fromEmail	string
fromName	string (OPTIONAL)
templates	Template[]

テンプレートプロパティ	型	列挙値
subject	string	N/A
content	string	N/A
usageType	enum string	'Register' / 'SignIn' / 'ForgotPassword' / 'Generic'
type	enum string	'text/plain' / 'text/html'