| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EmailRecordSink</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;">EmailRecordSink</h1><h2>Description: </h2><p>Provides a RecordSinkService that can be used to send records in email using the specified writer for formatting.</p><h3>Tags: </h3><p>email, smtp, record, sink, send, write</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>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 variable registry only)</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 variable registry only)</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 variable registry only)</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 variable registry only)</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 variable registry only)</strong></td></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 Server that is used to send Email Notifications</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 variable registry only)</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 variable registry only)</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 variable registry only)</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [SMTP Auth] Property </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 variable registry only)</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [SMTP Auth] Property </strong></td></tr><tr><td id="name"><strong>SMTP STARTTLS</strong></td><td>smtp-starttls</td><td id="default-value">false</td><td id="allowable-values"></td><td id="description">Flag indicating whether STARTTLS should be enabled. If the server does not support STARTTLS, the connection continues without the use of TLS<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>SMTP SSL</strong></td><td>smtp-ssl</td><td id="default-value">false</td><td id="allowable-values"></td><td id="description">Flag indicating whether SSL should be enabled<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>SMTP X-Mailer Header</strong></td><td>smtp-xmailer-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 variable registry only)</strong></td></tr><tr><td id="name"><strong>Record Writer</strong></td><td>record-sink-record-writer</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.19.1/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.1/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.19.1/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.1/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.1/org.apache.nifi.xml.XMLRecordSetWriter/index.html">XMLRecordSetWriter</a><br/><a href="../../../nifi-parquet-nar/1.19.1/org.apache.nifi.parquet.ParquetRecordSetWriter/index.html">ParquetRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.1/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.19.1/org.apache.nifi.lookup.RecordSetWriterLookup/index.html">RecordSetWriterLookup</a></td><td id="description">Specifies the Controller Service to use for writing out the records.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> |