Email: Send Email Out Adapter (SMTP)

The Send Email Out adapter sends email messages with fixed "From", "To", "Cc", "Bcc", "Subject", and "Body" fields in every email message as configured in the Adapter.

For each message that this output adapter receives, this adapter sends email to the specified address(es).

Property Name (screen)

Property Name (Attach Adapter)

Type

Description

SMTP Service

Service

String

Name of SMTPService definition in c8-services.xml.

To

To

String

Email address(es) to send the message to.

From

From

String

Email address that the generated email will be from.

Cc

Cc

String

Email address(es) to send the copy to.

Bcc

Bcc

String

Email address(es) to send the blind copy to.

Subject

Subject

String

Email subject.

Body template

BodyTemplate

String

Body template; in other words, the text of the message that you would like to send.

HTML Mail

HtmlMail

Boolean

Set this to true (in other words, put a checkmark in the box by clicking on the box) if you want the email sent in HTML format. Set this to false (in other words, remove the checkmark in the box by clicking on the box) if you do not want the email sent in HTML format.

Instead of specifying a specific value for the "From", "To", "Cc", "Bcc", "Subject", and "Body template" fields, you may use a property that tells the server to read the value from the stream. For example, suppose that your stream has a column named "ErrorCode", which contains an error number that you would like to include in the "Subject" field of the email message. You can put "ERROR = ?ErrorCode" in the "Subject" property of this adapter; when the recipient gets the message, the "?ErrorCode" will be replaced with the value in the ErrorCode field of the stream. The question mark character ("?") immediately preceding the "ErrorCode" tells the adapter to get the value in the ErrorCode field, rather than use "ErrorCode" as a literal value.

The c8-services.xml file needs to have an entry like this:

<Service Name="MySMTPServiceName" Type="SMTP">
  <Description>Description of MySMTPService</Description>
  <!-- Hostname of SMTIP service. Required -->
  <Param Name="Server">smtp.server.hostname</Param>   
  <!-- Port number of SMTP service. Optional -->
  <Param Name="Port"></Param>
  <!-- Username for SMTP service access. Optional -->
  <Param Name="Username">smtp.server.username</Param>
  <!-- Password for SMTP service access. Optional -->
  <Param Name="Password">smtp.server.password</Param>
</Service>

Obviously, the name here needs to match the name on the SMTPService property on the adapter. You need to correctly configure the Server param and optionally the Username and Password.