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.

NameDefault ValueAllowable ValuesDescription
SMTP HostnameThe hostname of the SMTP host
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP Port25The Port used for SMTP communications
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP UsernameUsername for the SMTP account
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP PasswordPassword for the SMTP account
Sensitive Property: true
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP AuthtrueFlag indicating whether authentication should be used
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP TLSfalseFlag indicating whether TLS should be enabled
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP Socket Factoryjavax.net.ssl.SSLSocketFactorySocket Factory to use for SMTP Connection
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP X-Mailer HeaderNiFiX-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 Typetext/plainMime 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)
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 flow file attributes and variable registry)
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 flow file attributes and variable registry)
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 flow file attributes and variable registry)
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 flow file attributes and variable registry)
SubjectMessage from NiFiThe email subject
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
MessageThe body of the email message
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Flow file content as messagefalseSpecifies 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 Filefalse
  • true
  • false
Specifies whether or not the FlowFile content should be attached to the email
Include All Attributes In Messagefalse
  • true
  • false
Specifies whether or not all FlowFile attributes should be recorded in the body of the email message

Relationships:

NameDescription
successFlowFiles that are successfully sent will be routed to this relationship
failureFlowFiles 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:

ResourceDescription
MEMORYThe 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.