ExtractEmailHeaders
Description
Using the flowfile content as source of data, extract header from an RFC compliant email file adding the relevant attributes to the flowfile. This processor does not perform extensive RFC validation but still requires a bare minimum compliance with RFC 2822
Tags
email, split
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 |
|---|---|---|---|---|
| Additional Header List | CAPTURED_HEADERS | x-mailer | COLON separated list of additional headers to be extracted from the flowfile content.NOTE the header key is case insensitive and will be matched as lower-case. Values will respect email contents. | |
| Email Address Parsing | STRICT_ADDRESS_PARSING | Strict Address Parsing |
| If "strict", strict address format parsing rules are applied to mailbox and mailbox list fields, such as "to" and "from" headers, and FlowFiles with poorly formed addresses will be routed to the failure relationship, similar to messages that fail RFC compliant format validation. If "non-strict", the processor will extract the contents of mailbox list headers as comma-separated values without attempting to parse each value as well-formed Internet mailbox addresses. This is optional and defaults to Strict Address Parsing |
Dynamic Properties
This component does not support dynamic properties.
Relationships
| Name | Description |
|---|---|
| failure | Flowfiles that could not be parsed as a RFC-2822 compliant message |
| success | Extraction was successful |
Reads Attributes
This processor does not read attributes.
Writes Attributes
| Name | Description |
|---|---|
| email.attachment_count | Number of attachments of the message |
| email.headers.bcc.* | Each individual BCC recipient (if available) |
| email.headers.cc.* | Each individual CC recipient (if available) |
| email.headers.from.* | Each individual mailbox contained in the From of the Email (array as per RFC-2822) |
| email.headers.message-id | The value of the Message-ID header (if available) |
| email.headers.received_date | The Received-Date of the message (if available) |
| email.headers.sent_date | Date the message was sent |
| email.headers.subject | Subject of the message (if available) |
| email.headers.to.* | Each individual TO recipient (if available) |
State Management
This component does not store state.
Restricted
This component is not restricted.
Input Requirement
This component requires an incoming relationship.
System Resource Considerations
This component does not specify system resource considerations.