EmailRecordSink

Description:

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

Tags:

email, smtp, record, sink, send, write

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueAllowable ValuesDescription
FromSpecifies the Email address to use as the sender. Comma separated sequence of addresses following RFC822 syntax.
Supports Expression Language: true (will be evaluated using variable registry only)
ToThe recipients to include in the To-Line of the email. Comma separated sequence of addresses following RFC822 syntax.
Supports Expression Language: true (will be evaluated using variable registry only)
CCThe recipients to include in the CC-Line of the email. Comma separated sequence of addresses following RFC822 syntax.
Supports Expression Language: true (will be evaluated using variable registry only)
BCCThe recipients to include in the BCC-Line of the email. Comma separated sequence of addresses following RFC822 syntax.
Supports Expression Language: true (will be evaluated using variable registry only)
SubjectMessage from NiFiThe email subject
Supports Expression Language: true (will be evaluated using variable registry only)
SMTP HostnameThe hostname of the SMTP Server that is used to send Email Notifications
SMTP Port25The Port used for SMTP communications
Supports Expression Language: true (will be evaluated using variable registry only)
SMTP AuthtrueFlag indicating whether authentication should be used
Supports Expression Language: true (will be evaluated using variable registry only)
SMTP UsernameUsername for the SMTP account
Supports Expression Language: true (will be evaluated using variable registry only)

This Property is only considered if the <SMTP Auth> Property has a value of "true".
SMTP PasswordPassword for the SMTP account
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)

This Property is only considered if the <SMTP Auth> Property has a value of "true".
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: true (will be evaluated using variable registry only)
SMTP SSLfalseFlag indicating whether SSL should be enabled
Supports Expression Language: true (will be evaluated using variable registry only)
SMTP X-Mailer HeaderNiFiX-Mailer used in the header of the outgoing email
Supports Expression Language: true (will be evaluated using variable registry only)
Record WriterController Service API:
RecordSetWriterFactory
Implementations: AvroRecordSetWriter
ScriptedRecordSetWriter
JsonRecordSetWriter
ParquetRecordSetWriter
RecordSetWriterLookup
FreeFormTextRecordSetWriter
XMLRecordSetWriter
CSVRecordSetWriter
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:

None specified.