Description
You can use the Mail job entry to send a text or HTML e-mail with optional file attachments.
Note: Do not confuse this with the Mail transformation step, which is slightly different.
Options
Option |
Description |
|---|---|
Name of the job entry |
The name of the job entry. This name has to be unique in a single job. A job entry can be placed several times on the canvas, however it will be the same job entry. |
Destination address |
The destination for the e-Mai. You can specify multiple addresses if you separate them with a space. |
Use authentication |
Check this if your SMTP server requires you to authenticate yourself. |
Authentication user |
The user name to authenticate with |
Authentication password |
The password to authenticate with. |
SMTP server |
The mail server to which the mail has to be sent. |
Reply address |
The reply address for this e-Mail |
Subject |
The subject of the e-Mail |
Include date in message |
Check this if you want to include the date in the e-Mail |
Contact person |
The name of the contact person to be placed in the e-Mail |
Contact phone |
The contact telephone number to be placed in the e-Mail |
Only send comment in mail body? |
Leave unchecked if you want details of the job's execution included in the mail (job name etc., job statistics [number of rows read/written/..., number of errors etc.], the job's log) |
Comment |
Additional comment to be placed in the e-Mail |
Attach files to message |
Check this if you want to attach files to this message. See the Tips below. |
Select the result files types to attach. |
When a transformation (or job) processes files (text, excel, dbf, etc) an entry is being added to the list of files in the result of that transformation or job. Specify the types of result files you want to add. |
Zip files into a single archive |
Check this if you want to zip all selected files into a single archive (recommended!) The zip filename Specify the name of the zip file that will be placed into the e-mail.
|
Tips
How to attach a particular file to the e-mail
You can attach "Result Files" of a particular type(s) to the e-mail, either individually or as a single ZIP archive by checking the option "Attach files to message" and selecting the types to attach under "Select the result files types to attach".
What is a Result File and how to create one? Well, just about any file created during a transformation may become a Result File, you only need to mark it as such. There are several ways to do that:
- When creating a file with a step that supports it, allow it to mark the file as a Result File.
For example the "Text file output" step has the check-box "Add filenames to result" on the File tab for that purpose. (I guess the file type would be General but aren't sure.) - Use the step "Set files in result" from the Job category to mark a file as a result file of a particular type. This steps expects the file name to be in a field (you can use e.g. "Generate Rows" in combination with "Add constants" to produce a row containing the file name).
See this forum message with an example attached.
Attaching transformation's log
You may easily attach a log file with log of a transformation run by the job prior to sending the mail as follows (suppose we have the job Start -> Transformation -> Mail):
- In the Transformation job entry's options, check "Specify logfile?" and enter a name and extension for the file. You can also specify the desired log level.
- In the Mail job entry's options, check "Attach files to message" and select (at least) the file type "Log".
- Voila! The next time the mail is send, it will have the transformation's log attached.