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
SMTP Port25The Port used for SMTP communications
Supports Expression Language: true
SMTP UsernameUsername for the SMTP account
Supports Expression Language: true
SMTP PasswordPassword for the SMTP account
Sensitive Property: true
Supports Expression Language: true
SMTP AuthtrueFlag indicating whether authentication should be used
Supports Expression Language: true
SMTP TLSfalseFlag indicating whether TLS should be enabled
Supports Expression Language: true
SMTP Socket Factoryjavax.net.ssl.SSLSocketFactorySocket Factory to use for SMTP Connection
Supports Expression Language: true
SMTP X-Mailer HeaderNiFiX-Mailer used in the header of the outgoing email
Supports Expression Language: true
Content Typetext/plainMime Type used to interpret the contents of the email, such as text/plain or text/html
Supports Expression Language: true
FromSpecifies the Email address to use as the sender
Supports Expression Language: true
ToThe recipients to include in the To-Line of the email
Supports Expression Language: true
CCThe recipients to include in the CC-Line of the email
Supports Expression Language: true
BCCThe recipients to include in the BCC-Line of the email
Supports Expression Language: true
SubjectMessage from NiFiThe email subject
Supports Expression Language: true
MessageThe body of the email message
Supports Expression Language: true
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
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.