tFileInputMail Standard properties - 6.4

Mail

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

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.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.

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.

Warning: Use absolute path (instead of relative path) for this field to avoid possible errors.

Mail parts

Specify what to extract from the defined MIME email file for each schema column.

  • Column: The Column cells are automatically filled with the column name defined in the schema.

  • Mail part: Type in the label of the header or body part to be extracted from the defined email.

  • Multi value: Select the check box next to the name of columns made of multi-value fields.

  • Separator: Enter a value separator for multi-value fields.

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.

Usage

Usage rule

This component handles flow of data therefore it requires output. It is defined as an intermediary step.