Show TOC

SMTP Output AdapterLocate this document in the navigation structure

Adapter type: smtp_out. The SMTP Output adapter sends an e-mail containing stream records.

For each record, the e-mail body contains:

  • Stream name
  • Columns names and values

If you use the CCL ATTACH ADAPTER statement to attach an adapter, you must supply the adapter type.

Property Label Description
SMTP Host

Property ID: smtpHost

Type: string

(Required) Name or IP address of the e-mail server. No default value.

fromAddress

Property ID: from

Type: string

(Required) E-mail address of the sender. No default value.

Importance Column

Property ID: importanceColumn

Type: string

(Required) Name of the stream column where the e-mail importance is stored. Valid values are: high, normal, and low. The default value is normal. The values are case-sensitive.

Address Column

Property ID: addressColumn

Type: string

(Required) Name of the column where a semicolon-delimited list of recipient e-mail addresses is stored. No default value.

Subject Column

Property ID: subjectColumn

Type: string

(Required) Name of the stream column where the e-mail subject is stored. No default value.

SMTP Port

Property ID: smtpPort

Type: uint

(Optional) Port used by the SMTP server. Default value is 25.

SMTP Username

Property ID: smtpUsername

Type: string

(Optional) Once you configure this property, the SMTP authentication requires the SMTP password to be set also.

SMTP Password

Property ID: smtpPassword

Type: string

(Optional) Set this property if you have set a SMTP user name.

Use SSL

Property ID: useSSL

Type: boolean

(Optional) If you want to enable this option, import the security certificate into the Java keystore file (located under install/lib/jre/lib/security/cacerts). Once the security certificate is configured, you can enable this option.

Default value is false.

Note Enable the SMTP server for SSL before configuring this option.
Use TLS

Property ID: useTLS

Type: boolean

(Optional) If you want to enable this option, import the security certificate into the Java keystore file (located under install/lib/jre/lib/security/cacerts). Once the security certificate is configured, you can enable this option.

Default value is false.
Note Enable the SMTP server for TLS before configuring this option.
cc Column

Property ID: ccColumn

Type: string

(Advanced) Name of the column where a semicolon-delimited list of recipient cc addresses is stored. By default, no cc e-mails are sent.

bcc Column

Property ID: bccColumn

Type: string

(Advanced) Name of the column where a semicolon-delimited list of recipient bcc addresses is stored. By default, no bcc e-mails are sent.

Column Names

Property ID: columnNames

Type: string

(Advanced) Colon-delimited names of stream columns whose values are included in the e-mail. By default, the e-mail contains values of all columns in the stream.

Show Column Names

Property ID: showColumnNames

Type: boolean

(Advanced) If true, the adapter includes the column names in the e-mail along with their values. If false, it includes only the values. Default value is true.

Number of Resend Attempts

Property ID: resendAttempts

Type: integer

(Advanced) The number of times to retry sending an e-mail if the initial attempt to send it fails. Default is 0, no attempt is made to resend e-mails.

Choose a moderate value (0 - 10) for this property. Requiring a large number of attempts to resend the e-mail may lead to excessive memory consumption, particularly if aggravated by network problems and a high volume of records waiting to be e-mailed.

Log Alert

Property ID: logAlert

Type: boolean

(Advanced) If true, logs an alert at debug level 1 each time the e-mail sending has been successful or failed. Default value is true.

SecondDate Format

Property ID: seconddateFormat

Type: string

(Advanced) SecondDate format. Default value is %Y-%m-%dT%H:%M:%S.

MsDate Format

Property ID: msdateFormat

Type: string

(Advanced) MsDate format. Default value is %Y-%m-%dT%H:%M:%S.

PropertySet

Property ID: propertyset

Type: string

(Advanced) Specifies the name of the property set. Property sets are reusable sets of properties that are stored in the project configuration file. Using these sets allows you to move adapter configuration properties out of the CCL file and into the CCR file. If you specify the same properties in the project configuration file and the ATTACH ADAPTER statement, the values in the property set override the values defined in the ATTACH ADAPTER statement. No default value.

Known limitations:

  • If you are a Microsoft® Outlook user, disable the feature that removes extra line breaks:
    1. Open Outlook, go to Start of the navigation path Tools Next navigation step Options End of the navigation path.
    2. On the Preferences tab, select E-mail Options.
    3. Click to clear the Remove extra line breaks in plain text messages check box. Click OK twice.