Skip to main content

EmailRecordSink

Description​

Provides a RecordSinkService that can be used to send records in email using the specified writer for formatting.

Tags​

email, record, send, sink, smtp, write

Properties​

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
From *fromSpecifies the Email address to use as the sender. Comma separated sequence of addresses following RFC822 syntax.

Supports Expression Language, using Environment variables.
TotoThe recipients to include in the To-Line of the email. Comma separated sequence of addresses following RFC822 syntax.

Supports Expression Language, using Environment variables.
CCccThe recipients to include in the CC-Line of the email. Comma separated sequence of addresses following RFC822 syntax.

Supports Expression Language, using Environment variables.
BCCbccThe recipients to include in the BCC-Line of the email. Comma separated sequence of addresses following RFC822 syntax.

Supports Expression Language, using Environment variables.
Subject *subjectMessage from NiFiThe email subject

Supports Expression Language, using Environment variables.
SMTP Hostname *smtp-hostnameThe hostname of the SMTP Server that is used to send Email Notifications
SMTP Port *smtp-port25The Port used for SMTP communications

Supports Expression Language, using Environment variables.
SMTP Auth *smtp-authtrueFlag indicating whether authentication should be used

Supports Expression Language, using Environment variables.
SMTP Usernamesmtp-usernameUsername for the SMTP account

Supports Expression Language, using Environment variables.

This property is only considered if:
  • the property SMTP Auth has a value of true
SMTP Passwordsmtp-passwordPassword for the SMTP account

Supports Expression Language, using Environment variables.

This property is only considered if:
  • the property SMTP Auth has a value of true
SMTP STARTTLS *smtp-starttlsfalseFlag indicating whether STARTTLS should be enabled. If the server does not support STARTTLS, the connection continues without the use of TLS

Supports Expression Language, using Environment variables.
SMTP SSL *smtp-sslfalseFlag indicating whether SSL should be enabled

Supports Expression Language, using Environment variables.
SMTP X-Mailer Header *smtp-xmailer-headerNiFiX-Mailer used in the header of the outgoing email

Supports Expression Language, using Environment variables.
Record Writer *record-sink-record-writerController Service:
RecordSetWriterFactory

Implementations:
AvroRecordSetWriter
CSVRecordSetWriter
FreeFormTextRecordSetWriter
JsonRecordSetWriter
RecordSetWriterLookup
ScriptedRecordSetWriter
XMLRecordSetWriter
Specifies the Controller Service to use for writing out the records.

State Management​

This component does not store state.

Restricted​

This component is not restricted.

System Resource Considerations​

This component does not specify system resource considerations.

See Also​