PutEmail

Description:

Sends an e-mail to configured recipients for each incoming FlowFile

Tags:

email, put, notify, smtp

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.

Name	Default Value	Allowable Values	Description
SMTP Hostname			The hostname of the SMTP host Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP Port	25		The Port used for SMTP communications Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP Username			Username for the SMTP account Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP Password			Password for the SMTP account Sensitive Property: true Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP Auth	true		Flag indicating whether authentication should be used Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP STARTTLS	false		Flag indicating whether Opportunistic TLS should be enabled using STARTTLS command Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP Socket Factory	javax.net.ssl.SSLSocketFactory		Socket Factory to use for SMTP Connection Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP X-Mailer Header	NiFi		X-Mailer used in the header of the outgoing email Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Attributes to Send as Headers (Regex)			A Regular Expression that is matched against all FlowFile attribute names. Any attribute whose name matches the regex will be added to the Email messages as a Header. If not specified, no FlowFile attributes will be added as headers.
Content Type	text/plain		Mime Type used to interpret the contents of the email, such as text/plain or text/html Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
From			Specifies the Email address to use as the sender. Comma separated sequence of addresses following RFC822 syntax. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
To			The 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 flow file attributes and variable registry)
CC			The 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 flow file attributes and variable registry)
BCC			The 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 flow file attributes and variable registry)
Subject	Message from NiFi		The email subject Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Message			The body of the email message Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Flow file content as message	false		Specifies whether or not the FlowFile content should be the message of the email. If true, the 'Message' property is ignored. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Attach File	false	true false	Specifies whether or not the FlowFile content should be attached to the email
Include All Attributes In Message	false	true false	Specifies whether or not all FlowFile attributes should be recorded in the body of the email message

Relationships:

Name	Description
success	FlowFiles that are successfully sent will be routed to this relationship
failure	FlowFiles that fail to send will be routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

Resource	Description
MEMORY	The entirety of the FlowFile's content (as a String object) will be read into memory in case the property to use the flow file content as the email body is set to true.