| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutEmail</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutEmail</h1><h2>Description: </h2><p>Sends an e-mail to configured recipients for each incoming FlowFile</p><h3>Tags: </h3><p>email, put, notify, smtp</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>SMTP Hostname</strong></td><td>SMTP Hostname</td><td></td><td id="allowable-values"></td><td id="description">The hostname of the SMTP host<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>SMTP Port</strong></td><td>SMTP Port</td><td id="default-value">25</td><td id="allowable-values"></td><td id="description">The Port used for SMTP communications<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">SMTP Username</td><td>SMTP Username</td><td></td><td id="allowable-values"></td><td id="description">Username for the SMTP account<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">SMTP Password</td><td>SMTP Password</td><td></td><td id="allowable-values"></td><td id="description">Password for the SMTP account<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>SMTP Auth</strong></td><td>SMTP Auth</td><td id="default-value">true</td><td id="allowable-values"></td><td id="description">Flag indicating whether authentication should be used<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>SMTP STARTTLS</strong></td><td>SMTP TLS</td><td id="default-value">false</td><td id="allowable-values"></td><td id="description">Flag indicating whether Opportunistic TLS should be enabled using STARTTLS command<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>SMTP Socket Factory</strong></td><td>SMTP Socket Factory</td><td id="default-value">javax.net.ssl.SSLSocketFactory</td><td id="allowable-values"></td><td id="description">Socket Factory to use for SMTP Connection<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>SMTP X-Mailer Header</strong></td><td>SMTP X-Mailer Header</td><td id="default-value">NiFi</td><td id="allowable-values"></td><td id="description">X-Mailer used in the header of the outgoing email<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Attributes to Send as Headers (Regex)</td><td>attribute-name-regex</td><td></td><td id="allowable-values"></td><td id="description">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.</td></tr><tr><td id="name"><strong>Content Type</strong></td><td>Content Type</td><td id="default-value">text/plain</td><td id="allowable-values"></td><td id="description">Mime Type used to interpret the contents of the email, such as text/plain or text/html<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>From</strong></td><td>From</td><td></td><td id="allowable-values"></td><td id="description">Specifies the Email address to use as the sender. Comma separated sequence of addresses following RFC822 syntax.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">To</td><td>To</td><td></td><td id="allowable-values"></td><td id="description">The recipients to include in the To-Line of the email. Comma separated sequence of addresses following RFC822 syntax.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">CC</td><td>CC</td><td></td><td id="allowable-values"></td><td id="description">The recipients to include in the CC-Line of the email. Comma separated sequence of addresses following RFC822 syntax.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">BCC</td><td>BCC</td><td></td><td id="allowable-values"></td><td id="description">The recipients to include in the BCC-Line of the email. Comma separated sequence of addresses following RFC822 syntax.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Subject</strong></td><td>Subject</td><td id="default-value">Message from NiFi</td><td id="allowable-values"></td><td id="description">The email subject<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Message</td><td>Message</td><td></td><td id="allowable-values"></td><td id="description">The body of the email message<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Flow file content as message</strong></td><td>email-ff-content-as-message</td><td id="default-value">false</td><td id="allowable-values"></td><td id="description">Specifies whether or not the FlowFile content should be the message of the email. If true, the 'Message' property is ignored.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Input Character Set</strong></td><td>input-character-set</td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">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.</td></tr><tr><td id="name"><strong>Attach File</strong></td><td>Attach File</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the FlowFile content should be attached to the email</td></tr><tr><td id="name"><strong>Include All Attributes In Message</strong></td><td>Include All Attributes In Message</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not all FlowFile attributes should be recorded in the body of the email message</td></tr></table><h3>Dynamic Properties: </h3><p>Supports Sensitive Dynamic Properties: <strong>Yes</strong></p><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">mail.propertyName</td><td id="value">Value for a specific property to be set in the JavaMail Session object</td><td>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.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that are successfully sent will be routed to this relationship</td></tr><tr><td>failure</td><td>FlowFiles that fail to send will be routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3><table id="system-resource-considerations"><tr><th>Resource</th><th>Description</th></tr><tr><td>MEMORY</td><td>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.</td></tr></table></body></html> |