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, and whether a property supports the NiFi Expression Language.

Display Name	API Name	Default Value	Allowable Values	Description
SMTP Hostname	SMTP Hostname			The hostname of the SMTP host Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP Port	SMTP Port	25		The Port used for SMTP communications Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Authorization Mode	authorization-mode	Use Password	Use Password Use OAuth2	How to authorize sending email on the user's behalf.
OAuth2 Access Token Provider	oauth2-access-token-provider		Controller Service API: OAuth2AccessTokenProvider Implementations: CdpOauth2AccessTokenProviderControllerService StandardOauth2AccessTokenProvider	OAuth2 service that can provide access tokens. This Property is only considered if the [Authorization Mode] Property has a value of "Use OAuth2".
SMTP Username	SMTP Username			Username for the SMTP account Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
SMTP Password	SMTP Password			Password for the SMTP account Sensitive Property: true Supports Expression Language: true (will be evaluated using flow file attributes and variable registry) This Property is only considered if the [Authorization Mode] Property has a value of "Use Password".
SMTP Auth	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	SMTP TLS	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	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	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)	attribute-name-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	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	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	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	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	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	Subject	Message from NiFi		The email subject Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Message	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	email-ff-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)
Input Character Set	input-character-set	UTF-8		Specifies 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.
Attach File	Attach File	false	true false	Specifies whether or not the FlowFile content should be attached to the email
Include All Attributes In Message	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

Dynamic Properties:

Supports Sensitive Dynamic Properties: Yes

Dynamic Properties allow the user to specify both the name and value of a property.

Name	Value	Description
mail.propertyName	Value for a specific property to be set in the JavaMail Session object	Dynamic property names that will be passed to the Mail session. Possible properties can be found in: https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

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.