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

Mailgun メールサービスを使用したメール認証の設定

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

ヒント:

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

前提条件​

基本設定​

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

配信​

Config オブジェクト​

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

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

使用タイプ​

次の使用タイプがサポートされています：

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

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

コンテンツ設定​

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

件名とコンテンツの両方で、{{code}} プレースホルダーを使用して認証コードを挿入できます。

直接 HTML コンテンツを使用するには、次のフィールドを入力します：

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

Mailgun テンプレートを使用するには、次のフィールドを入力します：

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

例​

以下は配信設定の例です：

{
  "Register": {
    "subject": "{{code}} is your verification code",
    "replyTo": "Foo <[email protected]>",
    "html": "<h1>Welcome to Logto</h1><p>Your verification code is {{code}}.</p>",
    "text": "Welcome to Logto. Your verification code is {{code}}."
  },
  "SignIn": {
    "subject": "Welcome back to Logto",
    "replyTo": "Foo <[email protected]>",
    "template": "logto-sign-in",
    "variables": {
      "bar": "baz"
    }
  }
}

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

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

以上です。サインイン体験でコネクターを有効化するのを忘れないでください。