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
Tags
Consume, Email, Get, Imap, Ingest, Ingress, Message
Properties
In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.
| Display Name | API Name | Default Value | Allowable Values | Description |
|---|---|---|---|---|
| Host Name * | host | Network address of Email server (e.g., pop.gmail.com, imap.gmail.com . . .) Supports Expression Language, using Environment variables. | ||
| Port * | port | Numeric value identifying Port of Email server (e.g., 993) Supports Expression Language, using Environment variables. | ||
| Authorization Mode * | authorization-mode | Use Password |
| How to authorize sending email on the user's behalf. |
| OAuth2 Access Token Provider * | oauth2-access-token-provider | Controller Service: OAuth2AccessTokenProvider Implementations: StandardOauth2AccessTokenProvider | OAuth2 service that can provide access tokens. This property is only considered if:
| |
| User Name * | user | User Name used for authentication and authorization with Email server. Supports Expression Language, using Environment variables. | ||
| Password * | password | Password used for authentication and authorization with Email server. Supports Expression Language, using Environment variables. This property is only considered if:
| ||
| Folder * | folder | INBOX | Email folder to retrieve messages from (e.g., INBOX) Supports Expression Language, using Environment variables. | |
| Fetch Size * | fetch.size | 10 | Specify the maximum number of Messages to fetch per call to Email Server. Supports Expression Language, using Environment variables. | |
| Delete Messages * | delete.messages | false |
| Specify whether mail messages should be deleted after retrieval. |
| Connection timeout * | connection.timeout | 30 sec | The amount of time to wait to connect to Email server Supports Expression Language, using Environment variables. | |
| Mark Messages as Read * | Mark Messages as Read | false |
| Specify if messages should be marked as read after retrieval. |
| Use SSL * | Use SSL | true |
| Specifies if IMAP connection must be obtained via SSL encrypted connection (i.e., IMAPS) |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| 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
This processor does not read attributes.
Writes Attributes
This processor does not write attributes.
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
This component does not specify system resource considerations.