Skip to main content

Email (Nodemailer) Writer

General

Send the output of a pipeline as an email. This module uses Nodemailer behind the scenes.

Module Options

Allow Invalid Certificates

Type: boolean
Required: False
Description: Allow secure connections to SMTP servers with invalid certificates. You should only use this if you or your organization trusts the SMTP server.

Authentication method

Type: enum
Required: True
Default Value: PLAIN
Options: None, PLAIN, LOGIN, CRAM-MD5, NTLM
Description: The authentication method to use when authenticating with the host. See Nodemailer for more information.

BCC

Type: string
Required: False
Description: Comma-separated list of addresses to blind-carbon-copy the email to.

CC

Type: string
Required: False
Description: Comma-separated list of addresses to carbon-copy the email to.

Sender

Type: string
Required: True
Description: The sender e-mail address. Replies will go to this address.

SMTP Host

Type: string
Required: True
Description: The SMTP host FQDN or IP address.

Example:

smtp.gmail.com

Message Contents (HTML)

Type: text
Required: False
Description: The HTML body of the email. Most e-mail clients support this and it will allow your emails to include some formatting. The actual HTML implementation varies between e-mail clients.

Pass

Type: password
Required: False
Description: The password to authenticate with.

Port

Type: integer
Required: True
Default Value: 587
Description: Which port to use when connecting to the SMTP host.

Secure Connection

Type: boolean
Required: True
Default Value: false
Description: Require a secure connection to the server.

Subject

Type: string
Required: False
Description: The subject of the e-mail. This is what recipients will see as the subject in their inbox.

Message Contents (Text)

Type: text
Required: False
Description: The text body of the e-mail. If an e-mail client does not support HTML, this is the content the recipients will see.

TLS Ciphers

Type: string
Required: False
Description: The TLS Cipher to use.

To

Type: string
Required: True
Description: A comma separated list of recipients.

Example:

john@test.com, joe@test.com, susan@test.com

User

Type: string
Required: False
Description: The user account to authenticate with the SMTP host.