PutEmail 2025.10.9.21

Bundle

org.apache.nifi | nifi-standard-nar

Description

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

Tags

email, notify, put, smtp

Input Requirement

REQUIRED

Supports Sensitive Dynamic Properties

true

Properties

PropertyDescription
Attach FileSpecifies whether or not the FlowFile content should be attached to the email
BCCThe recipients to include in the BCC-Line of the email. Comma separated sequence of addresses following RFC822 syntax.
CCThe recipients to include in the CC-Line of the email. Comma separated sequence of addresses following RFC822 syntax.
Content TypeMime Type used to interpret the contents of the email, such as text/plain or text/html
FromSpecifies the Email address to use as the sender. Comma separated sequence of addresses following RFC822 syntax.
Include All Attributes In MessageSpecifies whether or not all FlowFile attributes should be recorded in the body of the email message
MessageThe body of the email message
Reply-ToThe recipients that will receive the reply instead of the from (see RFC2822 §3.6.2).This feature is useful, for example, when the email is sent by a no-reply account. This field is optional. Comma separated sequence of addresses following RFC822 syntax.
SMTP AuthFlag indicating whether authentication should be used
SMTP HostnameThe hostname of the SMTP host
SMTP PasswordPassword for the SMTP account
SMTP PortThe Port used for SMTP communications
SMTP Socket FactorySocket Factory to use for SMTP Connection
SMTP TLSFlag indicating whether Opportunistic TLS should be enabled using STARTTLS command
SMTP UsernameUsername for the SMTP account
SMTP X-Mailer HeaderX-Mailer used in the header of the outgoing email
SubjectThe email subject
ToThe recipients to include in the To-Line of the email. Comma separated sequence of addresses following RFC822 syntax.
attribute-name-regexA 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.
authorization-modeHow to authorize sending email on the user’s behalf.
email-ff-content-as-messageSpecifies whether or not the FlowFile content should be the message of the email. If true, the ‘Message’ property is ignored.
input-character-setSpecifies the character set of the FlowFile contents for reading input FlowFile contents to generate the message body or as an attachment to the message. If not set, UTF-8 will be the default value.
oauth2-access-token-providerOAuth2 service that can provide access tokens.

Relationships

NameDescription
failureFlowFiles that fail to send will be routed to this relationship
successFlowFiles that are successfully sent will be routed to this relationship