メインコンテンツまでスキップ

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

Mailgun メールサービス用の公式 Logto コネクターです。

ヒント:

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

前提条件​

基本設定​

  • 別の Mailgun API エンドポイントを使用する場合は、endpoint フィールドに入力してください。例えば、EU リージョンの場合は https://api.eu.mailgun.net です。デフォルト値は https://api.mailgun.net です。
  • domain フィールドには、Mailgun アカウントで登録したドメインを入力してください。この値は Mailgun ダッシュボードの Domains セクションで確認できます。ドメインは example.com の形式で、https:// や http:// のプレフィックスは不要です。
  • apiKey フィールドには、Mailgun アカウントで生成した API キーを入力してください。
  • from フィールドには、メール送信元として使用するメールアドレスを入力してください。このメールアドレスは Mailgun アカウントに登録されている必要があります。メールアドレスは Sender Name <sender@example.com> の形式で入力してください。

配信設定​

Config オブジェクト​

「Deliveries」セクションでは、さまざまなシナリオで送信されるメールの内容を設定できます。これは JSON のキーと値のマップであり、キーが使用タイプ、値が送信するメールの内容設定を含むオブジェクトです。

{
  "<usage-type>": {
    // ...
  }
}

使用タイプ​

サポートされている使用タイプは以下の通りです：

  • Register：ユーザーが登録する際に送信されるメール。
  • SignIn：ユーザーがサインインする際に送信されるメール。
  • ForgotPassword：ユーザーがパスワードをリセットする際に送信されるメール。
  • Generic：ユーザーが汎用的なアクション（例：メールコネクターのテスト）を行う際に送信されるメール。
注記:

deliveries 設定で使用タイプが指定されていない場合は、汎用メールが送信されます。汎用メールも指定されていない場合、コネクターはエラーを返します。

内容設定​

コネクターは、直接 HTML コンテンツまたは Mailgun テンプレートの両方をサポートしています。各使用タイプごとにいずれかを利用できます。

件名や内容には {{code}} プレースホルダーを使用して認証コードを挿入できます。

直接 HTML コンテンツを使用する場合は、以下のフィールドを入力してください：

  • subject：送信するメールの件名。
  • replyTo：返信先として使用するメールアドレス。
  • html：（必須）送信するメールの HTML コンテンツ。
  • text：送信するメールのプレーンテキスト版。

Mailgun テンプレートを使用する場合は、以下のフィールドを入力してください：

  • subject：送信するメールの件名。
  • replyTo：返信先として使用するメールアドレス。
  • template：（必須）使用する Mailgun テンプレート名。
  • variables：Mailgun テンプレートに渡す変数。Mailgun へ送信前に文字列化されるため、JSON のキーと値のマップで指定してください。code 変数はコネクターによって自動的に追加されるため、含める必要はありません。

例​

以下は deliveries 設定の例です：

{
  "Register": {
    "subject": "{{code}} はあなたの認証コードです",
    "replyTo": "Foo <foo@bar.com>",
    "html": "<h1>Logto へようこそ</h1><p>あなたの認証コードは {{code}} です。</p>",
    "text": "Logto へようこそ。あなたの認証コードは {{code}} です。"
  },
  "SignIn": {
    "subject": "Logto へお帰りなさい",
    "replyTo": "Foo <foo@bar.com>",
    "template": "logto-sign-in",
    "variables": {
      "bar": "baz"
    }
  }
}

Mailgun メールコネクターのテスト​

メールアドレスを入力し、「送信」をクリックすることで、「保存して完了」前に設定が動作するか確認できます。

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