ConsumePOP3

Description:

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

Additional Details...

Tags:

Email, POP3, 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, 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.

NameDefault ValueAllowable ValuesDescription
Host NameNetwork address of Email server (e.g., pop.gmail.com, imap.gmail.com . . .)
Supports Expression Language: true
PortNumeric value identifying Port of Email server (e.g., 993)
Supports Expression Language: true
User NameUser Name used for authentication and authorization with Email server.
Supports Expression Language: true
PasswordPassword used for authentication and authorization with Email server.
Sensitive Property: true
Supports Expression Language: true
FolderINBOXEmail folder to retrieve messages from (e.g., INBOX)
Supports Expression Language: true
Fetch Size10Specify the maximum number of Messages to fetch per call to Email Server.
Supports Expression Language: true
Delete Messagesfalse
  • true
  • false
Specify whether mail messages should be deleted after retrieval.
Connection timeout30 secThe amount of time to wait to connect to Email server
Supports Expression Language: true

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.