ConsumeEWS

Description:

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

Tags:

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

Properties:

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, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
User NameuserUser Name used for authentication and authorization with Email server.
Supports Expression Language: true (will be evaluated using variable registry only)
PasswordpasswordPassword used for authentication and authorization with Email server.
Sensitive Property: true
Supports Expression Language: true (will be evaluated using variable registry only)
FolderfolderINBOXEmail folder to retrieve messages from (e.g., INBOX)
Supports Expression Language: true (will be evaluated using variable registry only)
Fetch Sizefetch.size10Specify the maximum number of Messages to fetch per call to Email Server.
Supports Expression Language: true (will be evaluated using variable registry only)
Delete Messagesdelete.messagesfalse
  • true
  • false
Specify whether mail messages should be deleted after retrieval.
Connection timeoutconnection.timeout30 secThe amount of time to wait to connect to Email server
Supports Expression Language: true (will be evaluated using variable registry only)
Exchange Versionmail-ews-versionExchange2010_SP2
  • Exchange2007_SP1
  • Exchange2010
  • Exchange2010_SP1
  • Exchange2010_SP2
What version of Exchange Server the server is running.
EWS URLews-urlURL of the EWS Endpoint. Required if Autodiscover is false.
Auto Discover URLews-autodiscovertrue
  • true
  • false
Whether or not to use the Exchange email address to Autodiscover the EWS endpoint URL.
Mark Messages as Readews-mark-as-readtrue
  • true
  • false
Specify if messages should be marked as read after retrieval.
Original Headers to Includeews-include-headersComma 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.
Original Headers to Excludeews-exclude-headersComma delimited list specifying which headers from the original message to exclude in the exported email message. Blank means don't exclude any headers.

Relationships:

NameDescription
successAll 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.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.