tPOP - 6.3

Composants Talend Open Studio Guide de référence

EnrichVersion
6.3
EnrichProdName
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
task
Création et développement
Gouvernance de données
Qualité et préparation de données
EnrichPlatform
Studio Talend

Fonction

Le composant tPOP récupère un ou plusieurs e-mails à partir d'un protocole POP3 ou IMAP.

Objectif

Le composant tPOP utilise le protocole POP ou IMAP pour se connecter au serveur de messagerie spécifié. Il récupère ensuite un ou plusieurs e-mails et écrit les informations récupérées dans un ou plusieurs fichiers définis. Les paramètres avancés (Advanced settings) permettent d'appliquer un ou plusieurs filtres à la sélection.

Propriétés du tPOP

Famille du composant

Internet

 

Basic settings

Host

Renseignez le nom de l'hôte ou l'adresse IP du serveur de messagerie auquel vous voulez vous connecter.

 

Port

Renseignez le numéro du port du serveur de messagerie.

 

Username et Password

Renseignez les informations d'authentification à votre compte de messagerie :

Username : entrez l'identifiant que vous utilisez pour accéder à votre boîte mail.

Password : entrez le mot de passe de connexion à votre boîte mail.

 

Output directory

Renseignez le chemin d'accès au dossier dans lequel vous voulez stocker les e-mails récupérés à partir de votre messagerie, ou cliquez sur [...] pour parcourir vos dossiers jusqu'à l'emplacement souhaité.

 

Filename pattern

Appuyez sur Ctrl+Espace pour afficher la liste des modèles prédéfinis ou définissez manuellement la syntaxe du nom des fichiers cible. Les données des e-mails récupérés à partir du serveur de messagerie sont écrites dans ces fichiers.

 

Retrieve all emails?

Cochez cette case pour récupérer tous les messages présents sur le serveur de messagerie.

 

Number of emails to retrieve

Saisissez le nombre de messages à récupérer.

Ce champ est disponible uniquement lorsque la case Retrieve all emails? est décochée.

 

Newer email first

Cochez cette case pour récupérer les messages les plus récents, en respectant le nombre spécifié dans le champ Number of emails to retrieve. Les messages récupérés seront retournés par ordre chronologique.

Cette case est disponible uniquement lorsque la case Retrieve all emails? (cochée par défaut) est décochée.

 

Delete emails from server

Cochez cette case si vous ne souhaitez pas conserver sur le serveur les e-mails récupérés.

Note

Pour les serveurs Gmail, cette option ne fonctionne pas avec le protocole POP3. Sélectionnez le protocole IMAP et vérifiez que le compte Gmail est configuré pour utiliser ce protocole.

 

Choose the protocol

Sélectionnez à partir de la liste déroulante le protocole à utiliser pour récupérer les e-mails. Le protocole dépend de celui utilisé par votre messagerie. Si vous choisissez le protocole imap, vous aurez la possibilité de spécifier le dossier contenant les e-mails que vous souhaitez récupérer.

 

Use SSL

Cochez cette case si votre serveur de messagerie utilise ce protocole de sécurisation des échanges.

Note

Cette option est obligatoire pour les utilisateurs de messagerie Gmail.

Advanced settings

tStatCatcher Statistics

Cochez cette case pour collecter les données de log au niveau du composant.

 

Filter

Cliquez sur le bouton [+] pour ajouter des lignes de filtre afin de ne récupérer qu'une sélection d'e-mails :

 

 

Filter item : sélectionnez l'un des types de filtre suivants à partir de la liste déroulante :

From : les messages sont filtrés en fonction de l'adresse e-mail de provenance.

To : les messages sont filtrés en fonction de l'adresse e-mail de destination.

Subject : les messages sont filtrés en fonction du sujet.

Before date : les messages sont filtrés en fonction de la date d'émission ou de réception ; ils doivent être antérieurs à la date indiquée.

After date : les messages sont filtrés en fonction de la date d'émission ou de réception ; ils doivent être postérieurs à la date indiquée.

 

 

Pattern : appuyez sur Ctrl+Espace pour afficher la liste des valeurs disponibles et sélectionnez la valeur à utiliser pour chacun des filtres.

 

Filter condition relation

Sélectionnez le type de relation à appliquer entre les filtres :

and : les conditions déterminées par les filtres s'ajoutent les unes aux autres, la recherche est plus restrictive.

or : les conditions déterminées par les filtres sont indépendantes les unes des autres, la recherche est plus large.

Global Variables

ERROR_MESSAGE : message d'erreur généré par le composant lorsqu'une erreur survient. Cette variable est une variable After et retourne une chaîne de caractères. Cette variable fonctionne uniquement si la case Die on error est décochée, si le composant a cette option.

NB_EMAIL : le nombre d'e-mail reçus. Cette variable est une variable After et retourne un nombre entier.

CURRENT_FILE : nom du fichier courant. Cette variable est une variable Flow et retourne une chaîne de caractères.

CURRENT_FILEPATH : nom du fichier courant ainsi que son chemin d'accès. Cette variable est une variable Flow et retourne une chaîne de caractères.

Une variable Flow fonctionne durant l'exécution d'un composant. Une variable After fonctionne après l'exécution d'un composant.

Pour renseigner un champ ou une expression à l'aide d'une variable, appuyez sur les touches Ctrl+Espace pour accéder à la liste des variables. A partir de cette liste, vous pouvez choisir la variable que vous souhaitez utiliser.

Pour plus d'informations concernant les variables, consultez le Guide utilisateur du Studio Talend.

Utilisation

Ce composant ne traite pas de flux de données, il peut donc être utilisé seul.

Log4j

Si vous utilisez une solution Talend soumise à souscription, l'activité de ce composant peut être journalisée avec la fonctionnalité log4j. Pour plus d'informations sur cette fonctionnalité, consultez le Guide utilisateur du Studio Talend.

Pour plus d'informations sur les niveaux de logs du log4j, consultez la documentation d'Apache : http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html (en anglais).

Limitation

Lorsque la case Use SSL est cochée ou que le protocole imap est sélectionné, le tPOP ne fonctionne pas avec IBM Java 6.

Scénario : Récupérer une sélection d'e-mails à partir d'un compte de messagerie

Ce scénario à un seul composant a pour but de récupérer un nombre prédéfini d'e-mails à partir d'un compte de messagerie.

  • A partir de la Palette, cliquez-déposez un composant tPOP dans l'éditeur graphique,

  • Double-cliquez sur le tPOP pour afficher la vue Basic settings et paramétrer le composant.

  • Renseignez les informations de connexion au serveur de messagerie : le nom de l'hôte ou son adresse IP entre guillemets dans le champ Host et le numéro de port dans le champ Port.

  • Saisissez ensuite les informations d'authentification de votre compte de messagerie. Dans le champ Username, saisissez entre guillemets votre identifiant et dans le champ Password, saisissez votre mot de passe. Dans cet exemple, le serveur de messagerie s'appelle Free.

  • Dans le champ Output directory, sélectionnez manuellement le chemin d'accès ou cliquez sur [...] pour sélectionner le dossier de destination des e-mails récupérés sur le serveur.

  • Dans le champ Filename pattern, définissez la syntaxe de nommage des fichiers de destination ou appuyez sur Ctrl+Espace pour afficher la liste des modèles prédéfinis. Dans cet exemple, la syntaxe est la suivante :

    TalendDate.getDate("yyyyMMdd-hhmmss") + "_" + (counter_tPOP_1 + 1) + ".txt" Les fichiers de destination, enregistrés au format texte, sont définis par leur date, heure et ordre de collecte.

  • Décochez la case Retrieve all emails? pour ne récupérer qu'un nombre défini d'e-mails. Dans cet exemple, 10 messages sont récupérés.

  • Cochez la case Delete emails from server pour supprimer les e-mails du serveur une fois qu'ils ont été récupérés en local.

  • Sélectionnez un type de protocole à partir de la liste déroulante Choose the protocol. Le choix du protocole dépend de celui utilisé par votre fournisseur de messagerie. Certains fournisseurs comme Gmail utilisent les deux protocoles. Dans cet exemple, le protocole sélectionné est pop3.

  • Enregistrez le Job puis appuyez sur F6 pour l'exécuter.

Le composant tPOP a ainsi récupéré les 10 derniers messages du compte de messagerie spécifié.

Pour chaque e-mail récupéré, un fichier .txt a été créé dans le dossier tPOP. Chaque fichier contient les métadonnées d'envoi du message (expéditeur, destinataire, objet du message) ainsi que les données propres au message.