tFileInputMail

Reads the standard key data of a given MIME or MSG email file.

tFileInputMail Standard properties

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

The Standard
tFileInputMail component belongs to the File family.

The component in this framework is available in all Talend
products.

Basic settings

File Name	Specify the email file to read and extract data from. Warning: Use absolute path (instead of relative path) for this field to avoid possible errors.
Schema and Edit Schema	A schema is a row description, it defines the number of fields to be processed and passed on to the next component. The schema is either Built-in or stored remotely in the Repository. Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available: View schema: choose this option to view the schema only. Change to built-in property: choose this option to change the schema to Built-in for local changes. Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion. If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the Repository Content window.
	Built-in: The schema will be created and stored locally for this component only. Related topic: see Talend Studio User Guide.
	Repository: The schema already exists and is stored in the Repository, hence can be reused in various projects and Job flowcharts. Related topic: see Talend Studio User Guide.
Mail type	Select a type of email from the drop-down list, either MIME or MSG.
Attachment export directory	Specify the directory to which you want to export email attachments.
Mail parts	Specify the header fields to extract from the MIME email file specified in the File Name field. Column: The Column cells are automatically filled with the column names defined in the schema. Mail part: Type in the names of the header fields or body parts to be extracted from the email file in double quotation marks. Refer to https://tools.ietf.org/html/rfc4021 for a list of MIME mail header fields. Multi value: Select this check box to allow multiple field values. Separator: Enter a character as the separators for multiple field values. This table appears only when MIME is selected from the Mail type drop-down list.
MSG Mail parts	Specify what to extract from the defined MSG email file for each schema column. Column: The Column cells are automatically filled with the column name defined in the schema. Mail part: Click each cell and then select an email part to be extracted. This table appears only when MSG is selected from the Mail type drop-down list.
Die on error	Select this check box to stop the execution of the Job when an error occurs. Clear the check box to skip the row on error and complete the process for error-free rows.

Advanced settings

tStatCatcher Statistics	Select this check box to gather the Job processing metadata at the Job level as well as at each component level.

Global Variables

Global Variables	EXPORTED_FILE_PATH: the directory to export mail attachment. This is a Flow variable and it returns a string. 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. 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.

EXPORTED_FILE_PATH: the directory to export mail
attachment. This is a Flow variable and it returns a string.

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.

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 handles flow of data therefore it requires output. It is defined as an intermediary step.

Extracting key fields from an email

This Java scenario describes a two-component Job that extracts some key standard
fields and displays the values on the Run
console.

Procedure

Drop a tFileInputMail and a tLogRow component from the Palette to the design workspace.
Connect the two components together using a Main
Row link.
Double-click tFileInputMail to display its
Basic settings view and define the
component properties.
Click the three-dot button next to the File
Name field and browse to the mail file to be processed.
Set schema type to Built-in and click the
three-dot button next to Edit schema to open a
dialog box where you can define the schema including all columns you want to
retrieve on your output.
Click the plus button in the dialog box to add as many columns as you want to
include in the output flow. In this example, the schema has four columns:
Date, Author,
Object and Status.
Once the schema is defined, click OK to close
the dialog box and propagate the schema into the Mail
parts table.
Click the three-dot button next to Attachment export directory and browse to
the directory in which you want to export email attachments, if any.
In the Mail part column of the Mail parts table, type in the actual header or body
standard keys that will be used to retrieve the values to be displayed.
Select the Multi Value check box next to any
of the standard keys if more than one value for the relative standard key is
present in the input file.
If needed, define a separator for the different values of the relative
standard key in the Separator field.
Double-click tLogRow to display its Basic settings view and define the component
properties in order for the values to be separated by a carriage return. On
Windows OS, type in
between double quotes.
Save your Job and press F6 to execute it and
display the output flow on the console.

The header key values are extracted as defined in the Mail
parts table. Mail reception date, author, subject and status are
displayed on the console.

Document get from Talend https://help.talend.com

Thank you for watching.

Docs 7.x

0 Comments

Inline Feedbacks

View all comments

tFileInputMail – Docs for ESB 7.x