tPOP Standard properties

POP

author
Talend Documentation Team
EnrichVersion
6.4
EnrichProdName
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Data Integration
Talend MDM Platform
Talend Open Studio for Data Integration
Talend Real-Time Big Data Platform
Talend ESB
Talend Open Studio for Big Data
Talend Data Services Platform
Talend Data Fabric
Talend Big Data Platform
Talend Big Data
Talend Data Management Platform
task
Design and Development > Third-party systems > Internet components (Integration) > POP components
Data Quality and Preparation > Third-party systems > Internet components (Integration) > POP components
Data Governance > Third-party systems > Internet components (Integration) > POP components
EnrichPlatform
Talend Studio

These properties are used to configure tPOP running in the Standard Job framework.

The Standard tPOP component belongs to the Internet family.

The component in this framework is generally available.

Basic settings

Host

IP address of the email server you want to connect to.

Port

Port number of the email server.

Username and Password

User authentication data for the email server.

Username: enter the username you use to access your email box.

Password: enter the password you use to access your email box.

Output directory

Enter the path to the file in which you want to store the email messages you retrieve from the email server, or click the three-dot button next to the field to browse to the file.

Filename pattern

Define the syntax of the names of the files that will hold each of the email messages retrieved from the email server, or press Ctrl+Space to display the list of predefined patterns.

Retrieve all emails?

Select this check box to retrieve all email messages present on the specified server.

Number of emails to retrieve

Enter the number of email messages you want to retrieve.

This field is available only when the Retrieve all emails? check box is cleared.

Newer email first

Select this check box to retrieve the most recent email messages according to the number specified in the Number of emails to retrieve field, and the email messages will be returned in chronological order.

This check box is available only when the Retrieve all emails? check box, which is selected by default, is cleared.

Delete emails from server

Select this check box if you do not want to keep the retrieved email messages on the server.

Note:

For Gmail servers, this option does not work for the pop3 protocol. Select the imap protocol and ensure that the Gmail account is configured to use imap.

Choose the protocol

From the list, select the protocol to be used to retrieve the email messages from the server. This protocol is the one used by the email server. If you choose the imap protocol, you will be able to select the folder from which you want to retrieve your emails.

Use SSL

Select this check box if your email server uses this protocol for authentication and communication confidentiality.

Note:

This option is obligatory for users of Gmail.

Advanced settings

tStatCatcher Statistics

Select this check box to gather the job processing metadata at a job level as well as at each component level.

Filter

Click the plus button to add as many lines as needed to filter email messages and retrieve only a specific selection:

 

Filter item: select one of the following filter types from the list:

From: email messages are filtered according to the sender email address.

To: email messages are filtered according to the recipient email address.

Subject: email messages are filtered according to the message subject matter.

Before date: email messages are filtered by the sending or receiving date. All messages before the set date are retrieved.

After date: email messages are filtered by the sending or receiving date. All messages after the set date are retrieved.

 

Pattern: press Ctrl+Space to display the list of available values. Select the value to use for each filter.

Filter condition relation

Select the type of logical relation you want to use to combine the specified filters:

and: the conditions set by the filters are combined together, the research is more restrictive.

or: the conditions set by the filters are independent, the research is large.

Global Variables

Global Variables

ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

NB_EMAIL: the number of emails received. This is an After variable and it returns an integer.

CURRENT_FILE: the current file name. This is a Flow variable and it returns a string.

CURRENT_FILEPATH: the current file path. This is a Flow variable and it returns a string.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.

Usage

Usage rule

This component does not handle data flow, it can be used alone.

Limitation

When the Use SSL check box or the imap protocol is selected, tPOP cannot work with IBM Java 6.