Consumes messages from Email Server using IMAP protocol. The raw-bytes of each received email message are written as contents of the FlowFile
| 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: true (will be evaluated using variable registry only) |
| Port | port | | | Numeric value identifying Port of Email server (e.g., 993)
Supports Expression Language: true (will be evaluated using variable registry only) |
| Authorization Mode | authorization-mode | Use Password | - Use Password
 - Use OAuth2
| How to authorize sending email on the user's behalf. |
| OAuth2 Access Token Provider | oauth2-access-token-provider | | Controller Service API:
OAuth2AccessTokenProvider
Implementations: CdpOauth2AccessTokenProviderControllerService
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 Name | user | | | User Name used for authentication and authorization with Email server.
Supports Expression Language: true (will be evaluated using variable registry only) |
| Password | password | | | Password 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". |
| Folder | folder | INBOX | | Email folder to retrieve messages from (e.g., INBOX)
Supports Expression Language: true (will be evaluated using variable registry only) |
| Fetch Size | fetch.size | 10 | | Specify the maximum number of Messages to fetch per call to Email Server.
Supports Expression Language: true (will be evaluated using variable registry only) |
| 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: true (will be evaluated using variable registry only) |
| 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) |