Saltar al contenido principal

Enviar correo electrónico con Gmail

Esta guía explica cómo enviar los correos electrónicos de Casdoor desde un buzón de Gmail o Google Workspace sin una contraseña de aplicación. El tipo Gmail inicia sesión en smtp.gmail.com con XOAUTH2: Casdoor obtiene un token OAuth 2.0 para el ámbito https://mail.google.com/ a partir de una clave JSON de Google e inicia sesión como el buzón remitente.


Resultados del aprendizaje​

  • Crear una clave JSON de Google que pueda enviar como un buzón.
  • Agregar Gmail como proveedor de correo electrónico en Casdoor y probarlo.

Requisitos​

  • Un dominio de Google Workspace y un superadministrador, o una cuenta personal de Gmail
  • Un proyecto de Google Cloud
  • Acceso de administrador a la consola de administración de Casdoor

Acerca de la clave JSON​

Casdoor acepta dos tipos de claves JSON de Google:

Clavetype en el JSONEnvía comoÚsela para
Clave de cuenta de servicio con delegación a nivel de dominioservice_accountLa From address, cualquier usuario del dominio WorkspaceGoogle Workspace
Credenciales de usuario con un token de actualizaciónauthorized_userLa cuenta que otorgó el token de actualizaciónGmail personal, o Workspace sin delegación

Crear una clave de cuenta de servicio (Google Workspace)​

  1. En la consola de Google Cloud, abra su proyecto, vaya a IAM & Admin > Service accounts y cree una cuenta de servicio, como casdoor-mail. No necesita roles.
  2. Abra la cuenta de servicio. En la pestaña Details, copie el Unique ID, que es su ID de cliente. En la pestaña Keys, haga clic en Add key > Create new key > JSON y guarde el archivo descargado.
  3. En la consola de administración de Google, vaya a Security > Access and data control > API controls > Manage Domain Wide Delegation y haga clic en Add new. Ingrese el ID de cliente y el ámbito https://mail.google.com/, y haga clic en Authorize.

La delegación puede tardar unos minutos en aplicarse.

Crear credenciales de usuario (Gmail personal)​

  1. En la consola de Google Cloud, configure la pantalla de consentimiento de OAuth de su proyecto y cree un ID de cliente OAuth del tipo Desktop app. Descargue su archivo JSON.

  2. Obtenga un token de actualización para el ámbito https://mail.google.com/ iniciando sesión con la cuenta que envía los correos electrónicos. Con la CLI gcloud:

    gcloud auth application-default login \
    --client-id-file=client_secret.json \
    --scopes=https://mail.google.com/
  3. gcloud escribe las credenciales en application_default_credentials.json en su carpeta de configuración (~/.config/gcloud/ en Linux y macOS, %APPDATA%\gcloud\ en Windows). El archivo tiene "type": "authorized_user", el ID de cliente, el secreto del cliente y el token de actualización.

Mientras la pantalla de consentimiento del proyecto esté en el estado Testing, Google expira los tokens de actualización después de 7 días. Publique la aplicación para mantener el token.

Agrega el proveedor en Casdoor​

  1. En la consola de administración de Casdoor, ve a Identity > Providers y agrega un proveedor.

  2. Establezca Category en Email y Type en Gmail. Casdoor rellena el host y el puerto.

  3. Complete los campos:

    CampoValue
    Google JSON keyEl contenido del archivo JSON de la clave de cuenta de servicio o las credenciales de usuario
    From addressEl buzón que envía los correos electrónicos. Con una cuenta de servicio, Casdoor inicia sesión como este usuario. Con credenciales de usuario, use la dirección de la cuenta que otorgó el token, o uno de sus alias
    From name(Opcional) El nombre visible del remitente
    Hostsmtp.gmail.com
    Port587
    SSL modeAuto, que usa STARTTLS en el puerto 587
  4. Escriba el Email title y el Email content. Consulte Plantillas.

  5. Guarde el proveedor.

Enable proxy envía tanto la solicitud de token como la conexión SMTP a través del proxy SOCKS5 de Casdoor. Consulta Proxy.

Verificar el resultado​

  1. Haz clic en Test SMTP Connection. Casdoor obtiene un token e inicia sesión en SMTP como la From address, sin enviar un correo.
  2. Haz clic en Send Testing Email y verifica que el mensaje llegue al buzón de Test Email.

Luego añade el proveedor a tu aplicación. Consulta Añadir proveedores a una aplicación.

Resolución de problemas​

ErrorCause
the from address of the Gmail email provider must be the mailbox that sends the emailsFrom address está vacío o no es una dirección de correo electrónico
the credentials of the Gmail email provider must be a Google JSON keyGoogle JSON key no es un JSON válido
the credentials of the Gmail email provider must be a "service_account" or "authorized_user" JSON keyEl JSON es otro tipo de clave, como un archivo de ID de cliente OAuth. Consulte About the JSON key
oauth2: cannot fetch token con unauthorized_clientFalta la delegación a nivel de dominio de la cuenta de servicio, tiene otro ID de cliente o carece del ámbito https://mail.google.com/
oauth2: cannot fetch token con invalid_grantEl token de actualización fue revocado o expiró, o la From address no es un usuario del dominio Workspace
535 5.7.8 Username and Password not acceptedGmail rechazó el token. Verifique que la From address sea la cuenta para la que se emitió el token

Véase también​