Consumes messages from Email Server using IMAP protocol. The raw-bytes of each received email message are written as contents of the FlowFile
Email, Imap, 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 nifi.properties file has an entry for the property nifi.sensitive.props.key.
| Name | Default Value | Allowable Values | Description |
|---|---|---|---|
| Host Name | 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 | Numeric value identifying Port of Email server (e.g., 993) Supports Expression Language: true (will be evaluated using variable registry only) | ||
| User Name | User Name used for authentication and authorization with Email server. Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Password | Password used for authentication and authorization with Email server. Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only) | ||
| Folder | INBOX | Email folder to retrieve messages from (e.g., INBOX) Supports Expression Language: true (will be evaluated using variable registry only) | |
| 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 | 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 (will be evaluated using variable registry only) | |
| Mark Messages as Read | false |
| Specify if messages should be marked as read after retrieval. |
| Use SSL | true |
| Specifies if IMAP connection must be obtained via SSL encrypted connection (i.e., IMAPS) |
| Name | Description |
|---|---|
| success | All messages that are the are successfully received from Email server and converted to FlowFiles are routed to this relationship |