| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeEWS</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;">ConsumeEWS</h1><h2>Description: </h2><p>Consumes messages from Microsoft Exchange using Exchange Web Services. The raw-bytes of each received email message are written as contents of the FlowFile</p><h3>Tags: </h3><p>Email, EWS, Exchange, Get, Ingest, Ingress, Message, Consume</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>User Name</strong></td><td>user</td><td></td><td id="allowable-values"></td><td id="description">User Name used for authentication and authorization with Email server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Password</strong></td><td>password</td><td></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization with Email server.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Folder</strong></td><td>folder</td><td id="default-value">INBOX</td><td id="allowable-values"></td><td id="description">Email folder to retrieve messages from (e.g., INBOX)<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Fetch Size</strong></td><td>fetch.size</td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">Specify the maximum number of Messages to fetch per call to Email Server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Delete Messages</strong></td><td>delete.messages</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specify whether mail messages should be deleted after retrieval.</td></tr><tr><td id="name"><strong>Connection timeout</strong></td><td>connection.timeout</td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait to connect to Email server<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Exchange Version</strong></td><td>mail-ews-version</td><td id="default-value">Exchange2010_SP2</td><td id="allowable-values"><ul><li>Exchange2007_SP1</li><li>Exchange2010</li><li>Exchange2010_SP1</li><li>Exchange2010_SP2</li></ul></td><td id="description">What version of Exchange Server the server is running.</td></tr><tr><td id="name">EWS URL</td><td>ews-url</td><td></td><td id="allowable-values"></td><td id="description">URL of the EWS Endpoint. Required if Autodiscover is false.</td></tr><tr><td id="name"><strong>Auto Discover URL</strong></td><td>ews-autodiscover</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not to use the Exchange email address to Autodiscover the EWS endpoint URL.</td></tr><tr><td id="name"><strong>Mark Messages as Read</strong></td><td>ews-mark-as-read</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specify if messages should be marked as read after retrieval.</td></tr><tr><td id="name">Original Headers to Include</td><td>ews-include-headers</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma delimited list specifying which headers from the original message to include in the exported email message. Blank means copy all headers. Some headers can cause problems with message parsing, specifically the 'Content-Type' header.</td></tr><tr><td id="name">Original Headers to Exclude</td><td>ews-exclude-headers</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma delimited list specifying which headers from the original message to exclude in the exported email message. Blank means don't exclude any headers.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All messages that are the are successfully received from Email server and converted to FlowFiles are 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 does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |