Email

Le connecteur Email 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 Email, effectuez les tâches suivantes :

  • Dans votre projet Google Cloud :
    • Assurez-vous que la connectivité réseau est configurée. Pour en savoir plus sur les schémas de réseau, consultez Connectivité réseau.
    • 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 type spécial de compte Google 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 en savoir plus, consultez 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 Activer des services.

    Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer au moment de configurer le connecteur.

Configurer le connecteur

Une connexion est propre à 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 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 Emplacements.

    2. Cliquez sur Suivant.
  4. Dans la section Détails de connexion, procédez comme suit :
    1. Connecteur : sélectionnez Email 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, indiquez le nom de l'instance de connexion.

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

      • Ils peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Ils doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Ils ne peuvent pas dépasser 49 caractères.
    4. (Facultatif) Description : saisissez une description pour la connexion.
    5. (Facultatif) Activez Cloud Logging, puis sélectionnez 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 le niveau de détail 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. (Facultatif) Configurez les paramètres des nœuds 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 davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez 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 améliorer la disponibilité) et le nombre maximal de nœuds sur 50.

    10. Utiliser un proxy : cochez cette case afin de configurer un serveur proxy pour la connexion ainsi que 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 :
        • De base : authentification HTTP de base.
        • Digest : authentification HTTP Digest.
      • Utilisateur du proxy : nom d'utilisateur permettant de s'authentifier 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 pour se connecter 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 : le protocole SSL est toujours activé pour la connexion.
        • Jamais : le protocole SSL n'est pas activé pour la connexion.
        • Tunnel : la connexion s'effectue avec 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. (Facultatif) Cliquez sur + Ajouter une étiquette pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
    12. Cliquez sur Suivant.
  5. Dans la section Destinations, saisissez le nom ou 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. Vous pouvez indiquer outlook.office365.com pour l'adresse de l'hôte et 993 pour le port.
      • Sélectionnez Adresse de l'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 de point de terminaison dans la liste, puis sélectionnez le rattachement de point de terminaison requis dans la liste Rattachement de 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 des e-mails, ajoutez les informations du serveur SMTP dans la section SMTPServer en cliquant sur + Ajouter une destination. Ensuite, procédez comme suit :
      • Saisissez l'adresse de l'hôte et le numéro de port. Vous pouvez indiquer smtp-mail.outlook.com pour l'adresse de l'hôte et 587 pour le port.
    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.

      Le type d'authentification suivant est compatible avec la connexion Email :

      • Nom d'utilisateur et mot de passe

      2. Pour savoir comment configurer ce type d'authentification, consultez Configurer l'authentification.

    2. Cliquez sur Suivant.
  7. Vérifier : vérifiez vos informations de connexion et d'authentification.
  8. Cliquez sur Créer.

Configurer l'authentification

Saisissez les informations en fonction de l'authentification que vous souhaitez utiliser.

  • Nom d'utilisateur et mot de passe
    • Nom d'utilisateur : utilisateur du compte Email utilisé pour l'authentification
    • Mot de passe : secret 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 par le biais de 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és. 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, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.

    Toutefois, il est possible qu'un connecteur n'accepte 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é. Voici les opérations possibles :

    Lorsque vous sélectionnez une entité dans la liste proposée, cela 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 "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.

  • Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de 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 un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Limites du système

Le connecteur Email peut traiter une transaction par seconde et par nœud, et limite les transactions au-delà de ce seuil. Par défaut, Integration Connectors alloue deux nœuds (pour améliorer la disponibilité) à une connexion.

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

Actions

Dans cette section, vous trouverez la liste des actions prises en charge par 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 Obligatoire Description
Description Chaîne Oui Boîte aux lettres vers laquelle le message sera déplacé.
Mailbox Chaîne Oui Boîte aux lettres dans laquelle le message se trouve actuellement.
Id Chaîne Oui Cette entrée indique l'ensemble de messages sur lesquels effectuer l'opération. Il peut s'agir d'un seul identifiant 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").

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

Action SendMailMessages

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

Nom du paramètre Type de données Obligatoire Description
BCC Chaîne Non Liste des noms et adresses e-mail des destinataires en Cci, séparés par un point-virgule.
Priority Chaîne Non Priorité du message.
Sensitivity Chaîne Non Niveau de confidentialité du message.
Attachment Chaîne Oui Liste des noms de fichiers joints (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 données d'une pièce jointe encodées en Base64 incluses dans le message, séparées par un point-virgule. Vous devez toujours spécifier le nom du fichier dans "Attachments".
InlineImage Chaîne Oui Liste des identifiants d'image intégrés (CID) à inclure dans le message, séparés par un point-virgule.
DeliveryNotification Chaîne Non Adresse e-mail à laquelle envoyer une notification de distribution.
InlineImageData Chaîne Oui Liste des données d'image encodées en Base64 à inclure dans le message, séparées par un point-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 à importer sous forme d'InputStream.
From Chaîne Non Adresse e-mail de l'expéditeur.
To Chaîne Non Liste des noms et adresses e-mail des destinataires, séparés par un point-virgule.
Subject Chaîne Oui Objet du message.
AttachmentContent Chaîne Non Contenu à importer sous forme d'InputStream.
Charset 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 texte brut.
Importance Chaîne Non Importance du message.

Pour savoir comment configurer l'action SendMailMessages, consultez Exemples d'actions.

Action SetLabels

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

Nom du paramètre Type de données Obligatoire Description
OperationType Chaîne Oui Indique si les libellés spécifiés doivent être ajoutés ou supprimés, ou doivent remplacer la liste de libellés existante.
Mailbox Chaîne Oui Boîte aux lettres Gmail dans laquelle se trouve le message.
Id Chaîne Oui Cette entrée indique l'ensemble de messages sur lesquels effectuer l'opération. Il peut s'agir d'un seul identifiant 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").
Label 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 Exemples d'actions.

Action SetFlag

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

Nom du paramètre Type de données Obligatoire Description
OperationType Chaîne Oui Indique si les indicateurs spécifiés doivent être ajoutés ou supprimés, ou doivent remplacer la liste d'indicateurs existante.
Mailbox Chaîne Oui Boîte aux lettres dans laquelle se trouve le message.
Id Chaîne Oui Cette entrée indique l'ensemble de messages sur lesquels effectuer l'opération. Il peut s'agir d'un seul identifiant 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").
Flags Chaîne Oui Définit les indicateurs spécifiés sur le message indiqué par l'ensemble de messages (par exemple, "Vu", "Supprimé", "Brouillon" et "Signalé"). Les indicateurs doivent être spécifiés sous forme de liste d'éléments séparés par une virgule (par exemple, Vu,Supprimé,Signalé).

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

Exemples

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, le paramètre de réponse connectorOutputPayload de la tâche MoveEmails aura une valeur semblable à la suivante :

    [{
"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 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 :
     {
"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 aboutit, le paramètre de réponse connectorOutputPayload de la tâche SendMailMessages aura une valeur semblable à la suivante :

    [{
 "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 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 :
     {
"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 aboutit, le paramètre de réponse connectorOutputPayload de la tâche SendMailMessages aura une valeur semblable à la suivante :

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

Exemple : Définir des libellés

  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 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 :
     {
"Labels": "GoogleCloud_Testing",
"OperationType": "ADD",
"Mailbox": "Inbox",
"Id": "1"
}

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

    [{
"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 aboutit, le paramètre de réponse connectorOutputPayload de la tâche SetFlag aura une valeur semblable à la suivante :

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

Exemple : Définir un indicateur pour un e-mail spécifique

  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 aboutit, le paramètre de réponse connectorOutputPayload de la tâche SetFlag aura une valeur semblable à la suivante :

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

Exemples d'opérations d'entité

Cette section explique comment effectuer certaines opérations d'entité 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. (Facultatif) Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez filtrer votre ensemble de résultats en spécifiant une clause de filtre. Indiquez toujours la valeur de la clause de filtre entre guillemets simples (').

Exemple : Récupérer 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 Entrée de la tâche de la tâche Connecteurs, cliquez sur EntityId, puis saisissez 1 dans le champ 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 Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 1 dans le champ Valeur par défaut.

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser la ressource Terraform pour créer une connexion.

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

Pour afficher un exemple de modèle Terraform permettant de créer une connexion, consultez 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 Obligatoire Description
protocol CHAÎNE Oui Type de serveur de messagerie auquel se connecter.
proxy_enabled BOOLÉEN Non Cochez cette case afin de configurer un serveur proxy pour la connexion.
proxy_auth_scheme ENUM Non Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Valeurs acceptées : BASIC, DIGEST et NONE.
proxy_user CHAÎNE Non Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
proxy_password SECRET Non Mot de passe à utiliser pour s'authentifier auprès du proxy ProxyServer.
proxy_ssltype ENUM Non Type SSL à utiliser pour se connecter au proxy ProxyServer. Valeurs acceptées : AUTO, ALWAYS, NEVER et TUNNEL.

Utiliser la connexion Email dans une intégration

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

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

Demander de l'aide à la communauté Google Cloud

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

Étapes suivantes