Consumes messages from Microsoft Exchange using Exchange Web Services. The raw-bytes of each received email message are written as contents of the FlowFile


Email, EWS, Exchange, Get, Ingest, Ingress, Message, Consume


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, whether a property supports the NiFi Expression Language, and whether a property is considered “sensitive”, meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the file has an entry for the property nifi.sensitive.props.key.

Name Default Value Allowable Values Description
User Name User Name used for authentication and authorization with Email server.
Supports Expression Language: true
Password Password used for authentication and authorization with Email server.
Sensitive Property: true
Supports Expression Language: true
Folder INBOX Email folder to retrieve messages from (e.g., INBOX)
Supports Expression Language: true
Fetch Size 10 Specify the maximum number of Messages to fetch per call to Email Server
Supports Expression Language: true
Delete Messages false * true
* false
Specify whether mail messages should be deleted after retrieval.
Connection timeout 30 sec The amount of time to wait to connect to Email server
Supports Expression Language: true
Exchange Version Exchange2010_SP2 * Exchange2007_SP1
* Exchange2010
* Exchange2010_SP1
* Exchange2010_SP2
What version of Exchange Server the server is running.
EWS URL URL of the EWS Endpoint. Required if Auto discover is false.
Auto Discover URL true * true
* false
Whether or not to use the Exchange email address to Auto discover the EWS endpoint URL.
Mark Messages as Read true * true
* false
Specify if messages should be marked as read after retrieval.


Name Description
success All messages that are the are successfully received from Email server and converted to FlowFiles are routed to this relationship

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.