tPOP – Docs for ESB 5.x

Component family

Internet

Function

The tPOP component fetches one or
more email messages from a server using the POP3 or IMAP protocol.

Purpose

The tPOP component uses the POP
or IMAP protocol to connect to a specific email server. Then it
fetches one or more email messages and writes the recovered
information in specified files. Parameters in the Advanced settings view allows you to use
filters on your selection.

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?

By default, all email messages present on the specified server are
retrieved.

To retrieve only a limited number of these email messages, clear
this check box and in the Number of emails to
retrieve.field, enter the number of messages you want
to retrieve. email messages are retrieved starting from the most
recent.

Delete emails from server

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

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.

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

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

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

Log4j

The activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User
Guide.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Limitation

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