E-mail

Le connecteur E-mail vous permet d'effectuer des opérations d'insertion, de suppression, de mise à jour et de lecture sur une base de données IMAP.

Avant de commencer

Avant d'utiliser le connecteur E-mail, effectuez les tâches suivantes :

  • Dans votre projet Google Cloud :
    • Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
    • Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un compte de service est un compte Google spécial destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez la section Créer un compte de service.

    • Activez les services suivants :
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Pour savoir comment activer des services, consultez la page Activer des services.

    Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

  1. Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Connexions"

  2. Cliquez sur + Créer pour ouvrir la page Créer une connexion.
  3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
    1. Région : sélectionnez un emplacement dans la liste déroulante.

      Pour obtenir la liste de toutes les régions disponibles, consultez la page Emplacements.

    2. Cliquez sur Next (Suivant).
  4. Dans la section Détails de connexion, procédez comme suit :
    1. Connecteur : sélectionnez E-mail dans la liste déroulante des connecteurs disponibles.
    2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
    3. Dans le champ Nom de connexion, saisissez un nom pour l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Les noms de connexion ne doivent pas dépasser 49 caractères.
    4. (Facultatif) Description : saisissez une description de la connexion.
    5. Vous pouvez également activer Cloud Logging, puis sélectionner un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur Error.
    6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    7. Protocole : type de serveur de messagerie auquel se connecter. Les valeurs valides sont IMAP et POP.
    8. Niveau de verbosité : ce champ détermine la quantité de détails que vous souhaitez inclure dans le fichier journal. Les valeurs valides sont comprises entre 1 et 5. Un niveau de verbosité plus élevé consigne tous les détails de la communication, y compris la requête, la réponse et les certificats SSL.
    9. Vous pouvez également configurer les paramètres du nœud de connexion :

      • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
      • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

      Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour une meilleure disponibilité) et le nombre maximal sur 50.

    10. Utiliser un proxy : cochez cette case pour configurer un serveur proxy pour la connexion, et spécifiez les valeurs suivantes :
      • Schéma d'authentification du proxy : sélectionnez le type d'authentification pour l'authentification auprès du serveur proxy. Les types d'authentification suivants sont compatibles :
        • Basique : authentification HTTP de base.
        • Condensé : authentification HTTP par condensé.
      • Utilisateur du proxy : nom d'utilisateur à utiliser pour l'authentification auprès du serveur proxy.
      • Mot de passe du proxy : secret Secret Manager du mot de passe de l'utilisateur.
      • Type SSL du proxy : type SSL à utiliser lors de la connexion au serveur proxy. Les types d'authentification suivants sont compatibles :
        • Auto : paramètre par défaut. Dans le cas d'une URL HTTPS, l'option "Tunnel" est utilisée. Dans le cas d'une URL HTTP, l'option "JAMAIS" est utilisée.
        • Toujours : la connexion SSL est toujours activée.
        • Jamais : la connexion n'est pas activée pour SSL.
        • Tunnel : la connexion s'effectue via un proxy de tunnelisation. Le serveur proxy ouvre une connexion à l'hôte distant et le trafic transite par le proxy.
      • Dans la section Serveur proxy, saisissez les détails du serveur proxy.
        1. Cliquez sur + Ajouter une destination.
        2. Sélectionnez un type de destination.
          • Adresse de l'hôte : spécifiez le nom d'hôte ou l'adresse IP de la destination.

            Si vous souhaitez établir une connexion privée à votre système backend, procédez comme suit :

    11. Vous pouvez également cliquer sur + Ajouter un libellé pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
    12. Cliquez sur Suivant.
  5. Dans la section Destinations, saisissez les détails du nom ou de l'adresse du serveur de messagerie auquel vous souhaitez vous connecter. Le serveur est compatible avec les protocoles IMAP ou POP.
    1. Type de destination : sélectionnez un type de destination. Par exemple, saisissez l'adresse de l'hôte et le numéro de port. Par exemple, l'adresse de l'hôte est outlook.office365.com et le port est 993.
      • Sélectionnez Adresse hôte dans la liste pour spécifier le nom d'hôte ou l'adresse IP de la destination.
      • Si vous souhaitez établir une connexion privée à vos systèmes backend, sélectionnez Rattachement du point de terminaison dans la liste, puis sélectionnez le rattachement du point de terminaison requis dans la liste Rattachement du point de terminaison.

      Si vous souhaitez établir une connexion publique à vos systèmes backend avec une sécurité supplémentaire, vous pouvez envisager de configurer des adresses IP sortantes statiques pour vos connexions, puis de configurer vos règles de pare-feu pour ajouter à la liste d'autorisation uniquement les adresses IP statiques spécifiques.

    2. Si vous souhaitez envoyer un e-mail, ajoutez les informations concernant le serveur SMTP dans la section Serveur SMTP en cliquant sur + Ajouter une destination. Ensuite, procédez comme suit :
      • Saisissez l'adresse de l'hôte et le numéro de port. Par exemple, l'adresse de l'hôte est smtp-mail.outlook.com et le port est 587.
    3. Cliquez sur Suivant.
  6. Dans la section Authentification, saisissez les informations d'authentification.
    1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Les types d'authentification suivants sont compatibles avec la connexion par e-mail :

      • Nom d'utilisateur et mot de passe

      2. Pour comprendre comment configurer ces types d'authentification, consultez la section Configurer l'authentification.

    2. Cliquez sur Next (Suivant).
  7. Vérifiez vos informations de connexion et d'authentification.
  8. Cliquez sur Créer.

Configurer l'authentification

Saisissez les détails en fonction de l'authentification que vous souhaitez utiliser.

  • Nom d'utilisateur et mot de passe
    • Nom d'utilisateur : utilisateur du compte de messagerie utilisé pour l'authentification.
    • Mot de passe : secret de Secret Manager contenant le mot de passe du compte de messagerie utilisé pour l'authentification.

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que via cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

  • Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connecté. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.

    Toutefois, il est possible qu'un connecteur ne soit pas compatible ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

  • Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Vous pouvez effectuer l'une des opérations suivantes sur une entité :

    La sélection d'une entité dans la liste disponible génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche de connecteur. Toutefois, si un connecteur n'accepte aucune des opérations d'entité, opérations ne sont pas répertoriées dans la liste Operations.

  • Action : une action est une fonction de première classe mise à la disposition de l'intégration via l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et une sortie . Toutefois, il est possible qu'un connecteur ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Limites du système

Le connecteur de messagerie peut traiter une transaction par seconde et par nœud, et limite les transactions au-delà de cette limite. Par défaut, les connecteurs d'intégration allouent deux nœuds (pour une meilleure disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez la section Limites.

Actions

Cette section répertorie les actions compatibles avec le connecteur. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Action MoveEmails

Paramètres d'entrée de l'action MoveEmails

Nom du paramètre Type de données Requis Description
Description Chaîne Oui Boîte aux lettres dans laquelle le message sera déplacé.
Boîte aux lettres Chaîne Oui Boîte de réception dans laquelle le message se trouve actuellement.
ID Chaîne Oui Ces entrées indiquent l'ensemble de messages à traiter. Il peut s'agir d'un identifiant de message unique, d'une plage de messages spécifiés par deux numéros de message séparés par le caractère ":" (par exemple, "1:5") et/ou des numéros de message séparés par une virgule (ex. : "1:5,7,10").

Pour savoir comment configurer l'action MoveEmails, consultez la section Exemples d'actions.

Action SendMailMessages

Paramètres d'entrée de l'action SendMailMessages

Nom du paramètre Type de données Requis Description
BCC Chaîne Non Liste des noms et adresses e-mail des destinataires en Cci, séparés par un point-virgule.
Priorité Chaîne Non Priorité du message.
Confidentialité Chaîne Non Sensibilité du message.
Rattachement Chaîne Oui Liste des noms de fichiers en pièce jointe (avec le chemin d'accès si la lecture est effectuée à partir d'un fichier) inclus dans le message, séparés par un point-virgule.
MessageBody Chaîne Oui Corps du message.
AttachmentData Chaîne Oui Liste des pièces jointes au message encodées en base64 (valeurs séparées par un point-virgule). (Vous devez quand même spécifier le nom du fichier dans "Pièces jointes".
InlineImage Chaîne Oui Liste des identifiants d'images intégrés (cids) à inclure dans le message, séparés par un point-virgule.
DeliveryNotification Chaîne Non Adresse e-mail à laquelle envoyer une notification de livraison.
InlineImageData Chaîne Oui Liste des données d'image encodées en base64 à inclure dans le message, séparées par une virgule.
CC Chaîne Non Liste des noms et adresses e-mail des destinataires en copie, séparés par un point-virgule.
InlineImageContent Chaîne Non Contenu en tant que flux d'entrée à importer.
De Chaîne Non Adresse e-mail de l'expéditeur.
À Chaîne Non Liste des noms et adresses e-mail des destinataires, séparés par un point-virgule.
Objet Chaîne Oui Objet de l'e-mail.
AttachmentContent Chaîne Non Contenu en tant que flux d'entrée à importer.
Jeu de caractères Chaîne Non Jeu de caractères à utiliser dans le message.
ReadReceipt Chaîne Non Adresse e-mail à laquelle envoyer une confirmation de lecture.
IsHTML Chaîne Non Indique si l'e-mail est au format HTML ou en texte brut.
Importance Chaîne Non Importance de l'e-mail.

Par exemple, pour configurer l'action SendMailMessages, consultez les exemples d'actions.

Action SetLabels

Paramètres d'entrée de l'action SetLabels

Nom du paramètre Type de données Requis Description
OperationType Chaîne Oui Indique si les libellés spécifiés doivent être ajoutés, supprimés ou remplacer la liste de libellés existante.
Boîte aux lettres Chaîne Oui Boîte aux lettres Gmail dans laquelle se trouve le message.
ID Chaîne Oui Ces entrées indiquent l'ensemble de messages à traiter. Il peut s'agir d'un identifiant de message unique, d'une plage de messages spécifiés par deux numéros de message séparés par le caractère ":" (par exemple, "1:5") et/ou des numéros de message séparés par une virgule (ex. : "1:5,7,10").
Libellé Chaîne Oui Liste des libellés à définir sur le message spécifié par la propriété MessageSet. Cette entrée doit être définie sur une liste de libellés séparés par une virgule.

Pour savoir comment configurer l'action SetLabels, consultez la section Exemples d'actions.

Action SetFlag

Paramètres d'entrée de l'action SetFlag

Nom du paramètre Type de données Requis Description
OperationType Chaîne Oui Indique si les indicateurs spécifiés doivent être ajoutés, supprimés ou remplacer la liste d'indicateurs existante.
Boîte aux lettres Chaîne Oui Boîte aux lettres dans laquelle se trouve le message.
ID Chaîne Oui Cette entrée indique l'ensemble des messages à traiter. Il peut s'agir d'un seul ID de message, d'une plage de messages spécifiée par deux numéros de message séparés par : (par exemple, "1:5") et/ou de numéros de message individuels séparés par , (par exemple, "1:5,7,10").
Options Chaîne Oui Définit les indicateurs spécifiés sur le message spécifié par l'ensemble de messages. (par exemple, (Vu, Supprimé, Brouillon, Signalé). Les indicateurs doivent être spécifiés sous la forme d'une liste d'éléments séparés par une virgule(par exemple, Seen,Deleted,flagged)

Pour savoir comment configurer l'action SetFlag, consultez la section Exemples d'actions.

Examples

Exemples d'actions

Exemple : Déplacer un e-mail

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action MoveEmails, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value : 
     {
"Destination": "Inbox",
"Mailbox": "Archive",
"Id": "1"
}

    4. Si l'action aboutit, la Réponse connectorOutputPayload de la tâche MoveEmails aura une valeur semblable à celle-ci:

    [{
"Success": "true",
"rss:title": "Message(s) moved successfully."
}]

Exemple : Envoyer un e-mail

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action SendMailMessages, puis cliquez sur OK.
  3. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value: 
     {
"MessageBody": "This mail is generated by using action sendmailmessage for outlook server.",
"To": "test97@gmail.com",
"Subject": "Outlook SMTP\n server."
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche SendMailMessages aura une valeur semblable à celle-ci :

    [{
 "MessageId": "4797386f18288a7441c5317a459b8340e857@outlook.com"
}]

Exemple : Envoyer un e-mail avec une pièce jointe

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action SendMailMessages, puis cliquez sur OK.
  3. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value: 
     {
"MessageBody": "This mail is generated by using action sendmailmessage for outlook server.",
"To": "test97@gmail.com",
"Subject": "Outlook SMTP PDF Mail.",
"Attachment": "Testing.pdf",
"AttachmentData": "JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBvYmoKPDwvTGVuz1xj6j3/gb09Wma83/dLbs7L9N03T/dHh6ArlrRiZdCU98lR5A3h9FD
...[too long to view on UI. Please download the log to view the full content.]
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche SendMailMessages aura une valeur semblable à celle-ci :

    [{
"MessageId": "1e96993a6053845c65ee44e6b4153d585e@outlook.com"
}]

Exemple – Définir des étiquettes

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action SetLabels, puis cliquez sur OK.
  3. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à celle-ci dans la section Champ Default Value: 
     {
"Labels": "GoogleCloud_Testing",
"OperationType": "ADD",
"Mailbox": "Inbox",
"Id": "1"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche SetLabels aura une valeur semblable à celle-ci :

    [{
"Success": "true",
"rss:title": "Message labels set correctly."
}]

Exemple – Définir un indicateur

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action SetFlag, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value : 
    {
"Mailbox": "Sent",
"Id": "1",
"Flags": "Draft",
"OperationType": "ADD"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche SetFlag aura une valeur semblable à celle-ci :

    [{
"Success": "true",
"rss:title": "Message flags set correctly."
}]

Exemple : Définir l'indicateur sur un e-mail particulier

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action SetFlag, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value : 
    {
"Mailbox": "Sent",
"Id": "1",
"Flags": "Flagged",
"OperationType": "ADD"
}

    4. Si l'action réussit, le paramètre de réponse connectorOutputPayload de la tâche SetFlag aura une valeur semblable à celle-ci :

    [{
"Success": "true",
"rss:title": "Message flags set correctly."
}]

Exemples d'opérations sur les entités

Cette section explique comment effectuer certaines opérations sur les entités dans ce connecteur.

Exemple : Lister tous les e-mails

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Inbox dans la liste Entity.
  3. Sélectionnez l'opération LIST, puis cliquez sur OK.
  4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), vous pouvez filtrer votre ensemble de résultats en spécifiant une clause de filtre. Spécifiez toujours la valeur de la clause de filtre entre guillemets simples (').

Exemple : Recevoir un seul e-mail

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Inbox dans la liste Entity.
  3. Sélectionnez l'opération GET, puis cliquez sur OK.
  4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur EntityId, puis saisissez 1 dans le champ Default Value (Valeur par défaut).

    Ici, 1 est un ID d'enregistrement unique dans l'entité Inbox.

Exemple : Supprimer un e-mail

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Inbox dans la liste Entity.
  3. Sélectionnez l'opération DELETE, puis cliquez sur OK.
  4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId, puis saisissez 1 dans le champ Default Value (Valeur par défaut).

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser l'outil Terraform ressource pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base.

Pour afficher un exemple de modèle Terraform pour la création de connexions, consultez cet exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform:

Nom du paramètre Type de données Requis Description
protocol STRING Vrai Type de serveur de messagerie auquel se connecter.
proxy_enabled VALEUR BOOLÉENNE Faux Cochez cette case pour configurer un serveur proxy pour la connexion.
proxy_auth_scheme ENUM Faux Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Les valeurs acceptées sont: BASIC, DIGEST, NONE
proxy_user STRING Faux Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
proxy_password SECRET Faux Mot de passe à utiliser pour l'authentification auprès du proxy ProxyServer.
proxy_ssltype ENUM Faux Type SSL à utiliser lors de la connexion au proxy ProxyServer. Les valeurs acceptées sont : AUTO, ALWAYS, NEVER et TUNNEL.

Utiliser la connexion E-mail dans une intégration

Une fois la connexion créée, elle devient disponible à la fois Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration via la tâche Connecteurs.

  • Pour comprendre comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez la section Tâche Connecteurs.
  • Pour découvrir comment créer et utiliser la tâche Connecteurs dans Application Integration, consultez la section Tâche Connecteurs.

Obtenir de l'aide auprès de la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étape suivante