ConsumeIMAP

Description:

Consumes messages from Email Server using IMAP protocol. The raw-bytes of each received email message are written as contents of the FlowFile

Additional Details...

Tags:

Email, Imap, 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
Host NamehostNetwork address of Email server (e.g., pop.gmail.com, imap.gmail.com . . .)
Supports Expression Language: true (will be evaluated using variable registry only)
PortportNumeric value identifying Port of Email server (e.g., 993)
Supports Expression Language: true (will be evaluated using variable registry only)
Authorization Modeauthorization-modeUse Password
  • Use Password Use password
  • Use OAuth2 Use OAuth2 to acquire access token
How to authorize sending email on the user's behalf.
OAuth2 Access Token Provideroauth2-access-token-providerController Service API:
OAuth2AccessTokenProvider
Implementation: StandardOauth2AccessTokenProvider		OAuth2 service that can provide access tokens.

This Property is only considered if the [Authorization Mode] Property has a value of "Use OAuth2".
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)

This Property is only considered if the [Authorization Mode] Property has a value of "Use Password".
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)
Mark Messages as ReadMark Messages as Readfalse
  • true
  • false
Specify if messages should be marked as read after retrieval.
Use SSLUse SSLtrue
  • true
  • false
Specifies if IMAP connection must be obtained via SSL encrypted connection (i.e., IMAPS)

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.