メインコンテンツにスキップ

Gmail でメールを送信する

このガイドでは、アプリパスワードなしで Gmail または Google Workspace のメールボックスから Casdoor のメールを送信する方法について説明します。Gmail タイプは XOAUTH2 を使用して smtp.gmail.com にサインインします。Casdoor は Google JSON キーから https://mail.google.com/ スコープ用の OAuth 2.0 トークンを取得し、送信元メールボックスとしてサインインします。


学習目標​

  • メールボックスとして送信できる Google JSON キーを作成します。
  • Casdoor に Gmail をメールプロバイダーとして追加し、テストします。

必要なもの​

  • Google Workspace ドメインとスーパー管理者、または個人用 Gmail アカウント
  • Google Cloud プロジェクト
  • Casdoor 管理コンソールへの管理者アクセス権限

JSON キーについて​

Casdoor は 2 種類の Google JSON キーを受け入れます:

キーJSON 内の type送信者用途
ドメイン全体の委任付きサービスアカウントキーservice_accountFrom address、Workspace ドメインの任意のユーザーGoogle Workspace
リフレッシュトークン付きのユーザー資格情報authorized_userリフレッシュトークンを承認したアカウント個人用 Gmail、または委任なしの Workspace

サービスアカウントキーの作成 (Google Workspace)​

  1. Google Cloud console でプロジェクトを開き、IAM & Admin > Service accounts に移動して、casdoor-mail などのサービスアカウントを作成します。ロールは必要ありません。
  2. サービスアカウントを開きます。Details タブで、クライアント ID である Unique ID をコピーします。Keys タブで、Add key > Create new key > JSON をクリックし、ダウンロードされたファイルを保管してください。
  3. Google Admin console で、Security > Access and data control > API controls > Manage Domain Wide Delegation に移動し、Add new をクリックします。クライアント ID とスコープ https://mail.google.com/ を入力し、Authorize をクリックします。

委任の適用には数分かかる場合があります。

ユーザー資格情報の作成 (個人用 Gmail)​

  1. Google Cloud console で、プロジェクトの OAuth 同意画面を設定し、タイプが Desktop app の OAuth クライアント ID を作成します。その JSON ファイルをダウンロードします。

  2. メールを送信するアカウントでサインインして、https://mail.google.com/ スコープのリフレッシュトークンを取得します。gcloud CLI を使用する場合:

    gcloud auth application-default login \
    --client-id-file=client_secret.json \
    --scopes=https://mail.google.com/
  3. gcloud は、構成フォルダー(Linux および macOS では ~/.config/gcloud/、Windows では %APPDATA%\gcloud\)内の application_default_credentials.json に資格情報を書き込みます。このファイルには "type": "authorized_user"、クライアント ID、クライアントシークレット、およびリフレッシュトークンが含まれています。

プロジェクトの同意画面が Testing ステータスの間、Google はリフレッシュトークンを 7 日後に失効させます。トークンを保持するにはアプリを公開してください。

Casdoor でプロバイダーを追加する​

  1. Casdoor 管理コンソールで Identity > Providers に移動し、プロバイダーを追加します。

  2. Category を Email に、Type を Gmail に設定します。Casdoor がホストとポートを入力します。

  3. フィールドに入力します:

    フィールド値
    Google JSON keyサービスアカウントキーまたはユーザー資格情報の JSON ファイルの内容
    From addressメールを送信するメールボックス。サービスアカウントの場合、Casdoor はこのユーザーとしてサインインします。ユーザー資格情報の場合、トークンを承認したアカウントのアドレス、またはそのエイリアスのいずれかを使用します
    From name(任意)送信者の表示名
    Hostsmtp.gmail.com
    Port587
    SSL modeAuto(ポート 587 で STARTTLS を使用)
  4. Email title と Email content を記述します。Templates を参照してください。

  5. プロバイダーを保存します。

Enable proxy を有効にすると、トークンリクエストと SMTP 接続の両方が Casdoor の SOCKS5 プロキシ経由で行われます。Proxy を参照してください。

結果の確認​

  1. Test SMTP Connection をクリックします。Casdoor はトークンを取得し、メールを送信せずに From address として SMTP にサインインします。
  2. Send Testing Email をクリックし、メッセージが Test Email メールボックスに届くことを確認します。

その後、アプリケーションにプロバイダーを追加します。Add providers to an application を参照してください。

トラブルシューティング​

ErrorCause
the from address of the Gmail email provider must be the mailbox that sends the emailsFrom address が空欄であるか、メールアドレスではありません
the credentials of the Gmail email provider must be a Google JSON keyGoogle JSON key が有効な JSON ではありません
the credentials of the Gmail email provider must be a "service_account" or "authorized_user" JSON keyJSON が別の種類のキーです(OAuth クライアント ID ファイルなど)。About the JSON key を参照してください
oauth2: cannot fetch token with unauthorized_clientサービスアカウントのドメイン全体の委任がありません、別のクライアント ID を持っています、または https://mail.google.com/ スコープがありません
oauth2: cannot fetch token with invalid_grantリフレッシュトークンが取り消されたか期限切れになったか、または From address が Workspace ドメインのユーザーではありません
535 5.7.8 Username and Password not acceptedGmail がトークンを拒否しました。From address がトークンが発行されたアカウントであることを確認してください

関連項目​