Перейти до основного вмісту

Надсилання електронних листів через Gmail

Цей посібник пояснює, як надсилати електронні листи Casdoor з поштової скриньки Gmail або Google Workspace без використання пароля додатку. Тип Gmail виконує вхід на smtp.gmail.com за допомогою XOAUTH2: Casdoor отримує токен OAuth 2.0 для області https://mail.google.com/ з ключа JSON Google і виконує вхід як відправник пошти.


Результати навчання​

  • Створіть ключ JSON Google, який може надсилати пошту від імені поштової скриньки.
  • Додайте Gmail як провайдера електронної пошти в Casdoor і протестуйте його.

Що потрібно​

  • Домен Google Workspace і суперадміністратор або особистий акаунт Gmail
  • Проєкт у Google Cloud
  • Адміністраторський доступ до консолі адміністрування Casdoor

Про ключ JSON​

Casdoor приймає два типи ключів JSON Google:

Ключtype у JSONНадсилає якВикористовуйте для
Ключ сервісного акаунта з делегуванням на рівні доменуservice_accountFrom address, будь-який користувач домену WorkspaceGoogle Workspace
Облікові дані користувача з токеном оновленняauthorized_userАкаунт, який надав токен оновленняОсобистий Gmail або Workspace без делегування

Створення ключа сервісного акаунта (Google Workspace)​

  1. У консолі Google Cloud відкрийте свій проєкт, перейдіть до IAM & Admin > Service accounts і створіть сервісний акаунт, наприклад casdoor-mail. Ролі йому не потрібні.
  2. Відкрийте сервісний акаунт. На вкладці Details скопіюйте Unique ID, який є його ідентифікатором клієнта. На вкладці Keys натисніть Add key > Create new key > JSON і збережіть завантажений файл.
  3. У консолі адміністратора Google перейдіть до Security > Access and data control > API controls > Manage Domain Wide Delegation і натисніть Add new. Введіть ідентифікатор клієнта та область https://mail.google.com/, потім натисніть Authorize.

Застосування делегування може зайняти кілька хвилин.

Створення облікових даних користувача (особистий Gmail)​

  1. У консолі Google Cloud налаштуйте екран узгодження OAuth вашого проєкту та створіть ідентифікатор клієнта OAuth типу Desktop app. Завантажте його файл 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 записує облікові дані у файл application_default_credentials.json у своїй папці конфігурації (~/.config/gcloud/ на Linux і macOS, %APPDATA%\gcloud\ на Windows). Файл містить "type": "authorized_user", ідентифікатор клієнта, секрет клієнта та токен оновлення.

Поки екран узгодження проєкту має статус Testing, Google видаляє токени оновлення через 7 днів. Опублікуйте додаток, щоб зберегти токен.

Додайте провайдера в Casdoor​

  1. У консолі адміністрування Casdoor перейдіть до Identity > Providers і додайте провайдера.

  2. Встановіть Category як Email і Type як Gmail. Casdoor автоматично заповнить хост і порт.

  3. Заповніть поля:

    ПолеЗначення
    Ключ JSON GoogleВміст файла JSON ключа сервісного акаунта або облікових даних користувача
    From addressПоштова скринька, яка надсилає електронні листи. Для сервісного акаунта Casdoor виконує вхід від імені цього користувача. Для облікових даних користувача використовуйте адресу акаунта, який надав токен, або одну з його альтернативних адрес
    From name(Необов'язково) Відображуване ім'я відправника
    Hostsmtp.gmail.com
    Port587
    SSL modeAuto, що використовує STARTTLS на порту 587
  4. Напишіть Email title та Email content. Див. Шаблони.

  5. Збережіть провайдера.

Enable proxy надсилає запит на отримання токена та з'єднання SMTP через SOCKS5-проксі Casdoor. Див. Proxy.

Перевірте результат​

  1. Натисніть Test SMTP Connection. Casdoor отримає токен і увійде в SMTP від імені адреси From address, без надсилання листа.
  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. Див. About the JSON key
oauth2: cannot fetch token з unauthorized_clientВідсутнє делегування на рівні домену для сервісного акаунта, має інший ідентифікатор клієнта або не має області https://mail.google.com/
oauth2: cannot fetch token з invalid_grantТокен оновлення був відкликаний або прострочений, або From address не є користувачем домену Workspace
535 5.7.8 Username and Password not acceptedGmail відхилив токен. Перевірте, що From address — це акаунт, для якого було видано токен

Див. також​