Skip to content

email writer

Nathan Richardson edited this page Oct 30, 2017 · 12 revisions
Email Writer

Icon

metl email 48x48 color

Use When

An email needs to be sent

Samples

You have a situation or business event where someone needs to be notified via email.

Description

The Email Writer is used to send one or multiple emails to one or multiple recipients.

The Email Writer can take one or more input messages. The writer will be executed according to the 'Run When' setting. Depending on the setting and the type of input message the email settings (subject, body, to …​) that have tokens will be filled out.

Attachments can also be included with the email message. The file(s) to be attached must be located on the local server of the Metl instance.

Inbound Message Type

Any

Output Message Type

Text Based Message

Properties
Name Description

Resource

A mail server session. If this is left blank, then the global mail server session will be used

Input Model

Enabled

Subject

The subject line for the email. This can be templated

Body

The body text for the email. This can be templated

FROM:

The from line for the email. If this is not set, the value will be used that is configured in the resource

TO:

The TO line for the email. This can be templated. The TO values can also be provided from a source step

CC:

The CC line for the email. This can be templated. The CC values can also be provided from a source step

BCC:

The BCC line for the email. This can be templated. The BCC values can also be provided from a source step

Source Step For Email Addresses

This is optional. If the recipients come from a database or source file this can be used to feed them to the component

Source Step Email Addresses Type

How to use the source recipients. Values can be TO, CC, and BCC

One Email per Recipient

Setting that indicates if multiple emails should be sent or just one

Include Attachment

Setting that indicates if an attachment should be included with the email sent

Attachment File Full Path

Fully qualified local server file path. To include multiple attachments include a pipe '|' between files.

For example: C:\Temp\testfile.txt|C:\Some Folder\My Filename Here.pdf

Run When

When this component should send email

Log Input

Log Output

Inbound Queue Capacity

Clone this wiki locally