Pular para o conteúdo principal

Send email with Gmail

Este guia explica como enviar os e-mails do Casdoor a partir de uma caixa de correio do Gmail ou Google Workspace sem usar uma senha de aplicativo. O tipo Gmail autentica-se no smtp.gmail.com com XOAUTH2: o Casdoor obtém um token OAuth 2.0 para o escopo https://mail.google.com/ a partir de uma chave JSON do Google e autentica-se como a caixa de correio remetente.


Resultados da aprendizagem​

  • Criar uma chave JSON do Google que possa enviar como uma caixa de correio.
  • Adicionar o Gmail como provedor de e-mail no Casdoor e testá-lo.

O que você precisa​

  • Um domínio do Google Workspace e um superadministrador, ou uma conta pessoal do Gmail
  • Um projeto do Google Cloud
  • Acesso de administrador ao console de administração do Casdoor

Sobre a chave JSON​

O Casdoor aceita dois tipos de chaves JSON do Google:

Chavetype no JSONEnvia comoUse para
Chave de service account com delegação em todo o domínioservice_accountO From address, qualquer usuário do domínio WorkspaceGoogle Workspace
Credenciais de usuário com refresh tokenauthorized_userA conta que concedeu o refresh tokenGmail pessoal, ou Workspace sem delegação

Criar uma chave de service account (Google Workspace)​

  1. No console do Google Cloud, abra seu projeto, vá para IAM & Admin > Service accounts e crie uma service account, como casdoor-mail. Ela não precisa de funções (roles).
  2. Abra a service account. Na aba Details, copie o Unique ID, que é o seu client ID. Na aba Keys, clique em Add key > Create new key > JSON e mantenha o arquivo baixado.
  3. No console de administração do Google, vá para Security > Access and data control > API controls > Manage Domain Wide Delegation e clique em Add new. Insira o client ID e o escopo https://mail.google.com/, e clique em Authorize.

A delegação pode levar alguns minutos para ser aplicada.

Criar credenciais de usuário (Gmail pessoal)​

  1. No console do Google Cloud, configure a tela de consentimento OAuth do seu projeto e crie um client ID OAuth do tipo Desktop app. Baixe o arquivo JSON correspondente.

  2. Obtenha um refresh token para o escopo https://mail.google.com/ autenticando-se com a conta que envia os e-mails. Com a CLI gcloud:

    gcloud auth application-default login \
    --client-id-file=client_secret.json \
    --scopes=https://mail.google.com/
  3. O gcloud escreve as credenciais em application_default_credentials.json na sua pasta de configuração (~/.config/gcloud/ no Linux e macOS, %APPDATA%\gcloud\ no Windows). O arquivo contém "type": "authorized_user", o client ID, o client secret e o refresh token.

Enquanto a tela de consentimento do projeto estiver no status Testing, o Google expira os refresh tokens após 7 dias. Publique o aplicativo para manter o token válido.

Adicione o provedor no Casdoor​

  1. No console de administração do Casdoor, vá para Identity > Providers e adicione um provedor.

  2. Defina Category como Email e Type como Gmail. O Casdoor preenche automaticamente o host e a porta.

  3. Preencha os campos:

    CampoValor
    Google JSON keyO conteúdo do arquivo JSON da chave de service account ou das credenciais de usuário
    From addressA caixa de correio que envia os e-mails. Com uma service account, o Casdoor autentica-se como este usuário. Com credenciais de usuário, use o endereço da conta que concedeu o token, ou um de seus aliases
    From name(Opcional) O nome de exibição do remetente
    Hostsmtp.gmail.com
    Port587
    SSL modeAuto, que usa STARTTLS na porta 587
  4. Escreva o Email title e o Email content. Consulte Templates.

  5. Salve o provedor.

Enable proxy envia tanto a solicitação de token quanto a conexão SMTP através do proxy SOCKS5 do Casdoor. Veja Proxy.

Verificar o resultado​

  1. Clique em Test SMTP Connection. O Casdoor obtém um token e se autentica no SMTP como o From address, sem enviar um e-mail.
  2. Clique em Send Testing Email e verifique se a mensagem chega na caixa de correio Test Email.

Em seguida, adicione o provedor à sua aplicação. Veja Adicionar provedores a uma aplicação.

Solução de problemas​

ErrorCause
the from address of the Gmail email provider must be the mailbox that sends the emailsFrom address está vazio ou não é um endereço de e-mail
the credentials of the Gmail email provider must be a Google JSON keyGoogle JSON key não é um JSON válido
the credentials of the Gmail email provider must be a "service_account" or "authorized_user" JSON keyO JSON é outro tipo de chave, como um arquivo de client ID OAuth. Veja Sobre a chave JSON
oauth2: cannot fetch token com unauthorized_clientA delegação em todo o domínio da service account está ausente, tem outro client ID ou carece do escopo https://mail.google.com/
oauth2: cannot fetch token com invalid_grantO refresh token foi revogado ou expirou, ou o From address não é um usuário do domínio Workspace
535 5.7.8 Username and Password not acceptedO Gmail recusou o token. Verifique se o From address é a conta para a qual o token foi emitido

Veja também​