| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListenSMTP</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;">ListenSMTP</h1><h2>Description: </h2><p>This processor implements a lightweight SMTP server to an arbitrary port, allowing nifi to listen for incoming email. Note this server does not perform any email validation. If direct exposure to the internet is sought, it may be a better idea to use the combination of NiFi and an industrial scale MTA (e.g. Postfix). Threading for this processor is managed by the underlying smtp server used so the processor need not support more than one thread.</p><h3>Tags: </h3><p>listen, email, 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.</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>Listening Port</strong></td><td>SMTP_PORT</td><td></td><td id="allowable-values"></td><td id="description">The TCP port the ListenSMTP processor will bind to.NOTE that on Unix derivative operating systems this port must be higher than 1024 unless NiFi is running as with root user permissions.</td></tr><tr><td id="name"><strong>Maximum number of SMTP connection</strong></td><td>SMTP_MAXIMUM_CONNECTIONS</td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The maximum number of simultaneous SMTP connections.</td></tr><tr><td id="name"><strong>SMTP connection timeout</strong></td><td>SMTP_TIMEOUT</td><td id="default-value">60 seconds</td><td id="allowable-values"></td><td id="description">The maximum time to wait for an action of SMTP client.</td></tr><tr><td id="name"><strong>SMTP Maximum Message Size</strong></td><td>SMTP_MAXIMUM_MSG_SIZE</td><td id="default-value">20 MB</td><td id="allowable-values"></td><td id="description">The maximum number of bytes the server will accept.</td></tr><tr><td id="name">SSL Context Service</td><td>SSL_CONTEXT_SERVICE</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.19.1/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context. If this property is set, messages will be received over a secure connection.</td></tr><tr><td id="name">Client Auth</td><td>CLIENT_AUTH</td><td></td><td id="allowable-values"><ul><li>NONE</li><li>REQUIRED</li></ul></td><td id="description">The client authentication policy to use for the SSL Context. Only used if an SSL Context Service is provided.</td></tr><tr><td id="name">SMTP hostname</td><td>SMTP_HOSTNAME</td><td></td><td id="allowable-values"></td><td id="description">The hostname to be embedded into the banner displayed when an SMTP client connects to the processor TCP port .</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All new messages will be routed as FlowFiles to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>smtp.helo</td><td>The value used during HELO</td></tr><tr><td>smtp.certificates.*.serial</td><td>The serial numbers for each of the certificates used by an TLS peer</td></tr><tr><td>smtp.certificates.*.principal</td><td>The principal for each of the certificates used by an TLS peer</td></tr><tr><td>smtp.src</td><td>The source IP and port of the SMTP connection</td></tr><tr><td>smtp.from</td><td>The value used during MAIL FROM (i.e. envelope)</td></tr><tr><td>smtp.recipient.*</td><td>The values used during RCPT TO (i.e. envelope)</td></tr><tr><td>mime.type</td><td>Mime type of the message</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |