Passer au contenu principal

Envoyer des e-mails avec Gmail

Ce guide explique comment envoyer les e-mails de Casdoor depuis une boîte aux lettres Gmail ou Google Workspace sans utiliser de mot de passe d'application. Le type Gmail se connecte à smtp.gmail.com avec XOAUTH2 : Casdoor obtient un jeton OAuth 2.0 pour la portée https://mail.google.com/ à partir d'une clé JSON Google, et se connecte en tant que boîte aux lettres émettrice.


Objectifs d'apprentissage​

  • Créez une clé JSON Google autorisée à envoyer des e-mails en tant que boîte aux lettres.
  • Ajoutez Gmail comme fournisseur d'e-mails dans Casdoor et testez-le.

Prérequis​

  • Un domaine Google Workspace et un super administrateur, ou un compte Gmail personnel
  • Un projet Google Cloud
  • Accès administrateur à la console d'administration Casdoor

À propos de la clé JSON​

Casdoor accepte deux types de clés JSON Google :

Clétype dans le JSONEnvoie en tant queUtilisez-la pour
Clé de compte de service avec délégation à l'échelle du domaineservice_accountL'From address, tout utilisateur du domaine WorkspaceGoogle Workspace
Identifiants utilisateur avec un jeton d'actualisationauthorized_userLe compte qui a accordé le jeton d'actualisationGmail personnel, ou Workspace sans délégation

Créer une clé de compte de service (Google Workspace)​

  1. Dans la console Google Cloud, ouvrez votre projet, allez dans IAM & Admin > Service accounts, et créez un compte de service, par exemple casdoor-mail. Il n'a besoin d'aucun rôle.
  2. Ouvrez le compte de service. Dans l'onglet Details, copiez l'Unique ID, qui est son ID client. Dans l'onglet Keys, cliquez sur Add key > Create new key > JSON, et conservez le fichier téléchargé.
  3. Dans la console d'administration Google, allez dans Security > Access and data control > API controls > Manage Domain Wide Delegation, et cliquez sur Add new. Entrez l'ID client et la portée https://mail.google.com/, puis cliquez sur Authorize.

La délégation peut prendre quelques minutes avant de s'appliquer.

Créer des identifiants utilisateur (Gmail personnel)​

  1. Dans la console Google Cloud, configurez l'écran de consentement OAuth de votre projet et créez un ID client OAuth de type Desktop app. Téléchargez son fichier JSON.

  2. Obtenez un jeton d'actualisation pour la portée https://mail.google.com/ en vous connectant avec le compte qui envoie les e-mails. Avec l'interface CLI gcloud :

    gcloud auth application-default login \
    --client-id-file=client_secret.json \
    --scopes=https://mail.google.com/
  3. gcloud écrit les identifiants dans application_default_credentials.json dans son dossier de configuration (~/.config/gcloud/ sous Linux et macOS, %APPDATA%\gcloud\ sous Windows). Le fichier contient "type": "authorized_user", l'ID client, le secret client et le jeton d'actualisation.

Tant que l'écran de consentement du projet est en statut Testing, Google fait expirer les jetons d'actualisation après 7 jours. Publiez l'application pour conserver le jeton.

Ajouter le fournisseur dans Casdoor​

  1. Dans la console d'administration Casdoor, accédez à Identity > Providers et ajoutez un fournisseur.

  2. Définissez Category sur Email et Type sur Gmail. Casdoor remplit automatiquement l'hôte et le port.

  3. Remplissez les champs :

    ChampValeur
    Clé JSON GoogleLe contenu du fichier JSON de la clé de compte de service ou des identifiants utilisateur
    From addressLa boîte aux lettres qui envoie les e-mails. Avec un compte de service, Casdoor se connecte en tant que cet utilisateur. Avec des identifiants utilisateur, utilisez l'adresse du compte qui a accordé le jeton, ou l'un de ses alias
    From name(Facultatif) Le nom d'affichage de l'expéditeur
    Hostsmtp.gmail.com
    Port587
    SSL modeAuto, qui utilise STARTTLS sur le port 587
  4. Rédigez le titre de l'e-mail (Email title) et le contenu de l'e-mail (Email content). Consultez Modèles.

  5. Enregistrez le fournisseur.

L'option Enable proxy fait passer la demande de jeton et la connexion SMTP via le proxy SOCKS5 de Casdoor. Voir Proxy.

Vérifier le résultat​

  1. Cliquez sur Test SMTP Connection. Casdoor obtient un jeton et se connecte à SMTP en tant que From address, sans envoyer d'e-mail.
  2. Cliquez sur Send Testing Email et vérifiez que le message arrive bien dans la boîte aux lettres Test Email.

Ajoutez ensuite le fournisseur à votre application. Voir Add providers to an application.

Dépannage​

ErrorCause
the from address of the Gmail email provider must be the mailbox that sends the emailsL'From address est vide ou n'est pas une adresse e-mail
the credentials of the Gmail email provider must be a Google JSON keyLa Google JSON key n'est pas un JSON valide
the credentials of the Gmail email provider must be a "service_account" or "authorized_user" JSON keyLe JSON est un autre type de clé, comme un fichier d'ID client OAuth. Voir À propos de la clé JSON
oauth2: cannot fetch token avec unauthorized_clientLa délégation à l'échelle du domaine du compte de service est manquante, utilise un autre ID client, ou manque la portée https://mail.google.com/
oauth2: cannot fetch token avec invalid_grantLe jeton d'actualisation a été révoqué ou a expiré, ou l'From address n'est pas un utilisateur du domaine Workspace
535 5.7.8 Username and Password not acceptedGmail a refusé le jeton. Vérifiez que l'From address est bien le compte pour lequel le jeton a été émis

Voir aussi​