org.apache.nifinifi-email-nar2.2.0org.apache.nifinifi-standard-services-api-nar2.2.02.0.0rel/nifi-2.2.0main1org.apache.nifi.processors.email.ConsumeIMAPPROCESSORConsumes messages from Email Server using IMAP protocol. The raw-bytes of each received email message are written as contents of the FlowFileEmailImapGetIngestIngressMessageConsumehostHost NameNetwork address of Email server (e.g., pop.gmail.com, imap.gmail.com . . .)truefalsetrueENVIRONMENTfalsefalseportPortNumeric value identifying Port of Email server (e.g., 993)truefalsetrueENVIRONMENTfalsefalseauthorization-modeAuthorization ModeHow to authorize sending email on the user's behalf.password-based-authorization-modeUse Passwordpassword-based-authorization-modeUse passwordUse OAuth2oauth-based-authorization-modeUse OAuth2 to acquire access tokentruefalsefalseNONEfalsefalseoauth2-access-token-providerOAuth2 Access Token ProviderOAuth2 service that can provide access tokens.org.apache.nifi.oauth2.OAuth2AccessTokenProviderorg.apache.nifinifi-standard-services-api-nar2.2.0truefalsefalseNONEfalsefalseauthorization-modeAuthorization Modeoauth-based-authorization-modeuserUser NameUser Name used for authentication and authorization with Email server.truefalsetrueENVIRONMENTfalsefalsepasswordPasswordPassword used for authentication and authorization with Email server.truetruetrueENVIRONMENTfalsefalseauthorization-modeAuthorization Modepassword-based-authorization-modefolderFolderEmail folder to retrieve messages from (e.g., INBOX)INBOXtruefalsetrueENVIRONMENTfalsefalsefetch.sizeFetch SizeSpecify the maximum number of Messages to fetch per call to Email Server.10truefalsetrueENVIRONMENTfalsefalsedelete.messagesDelete MessagesSpecify whether mail messages should be deleted after retrieval.falsetruetruefalsefalsetruefalsefalseNONEfalsefalseconnection.timeoutConnection timeoutThe amount of time to wait to connect to Email server30 sectruefalsetrueENVIRONMENTfalsefalseMark Messages as ReadMark Messages as ReadSpecify if messages should be marked as read after retrieval.falsetruetruefalsefalsetruefalsefalseNONEfalsefalseUse SSLUse SSLSpecifies if IMAP connection must be obtained via SSL encrypted connection (i.e., IMAPS)truetruetruefalsefalsetruefalsefalseNONEfalsefalsesuccessAll messages that are the are successfully received from Email server and converted to FlowFiles are routed to this relationshipfalseINPUT_FORBIDDENorg.apache.nifi.processors.email.ConsumePOP3PROCESSORConsumes messages from Email Server using POP3 protocol. The raw-bytes of each received email message are written as contents of the FlowFileEmailPOP3GetIngestIngressMessageConsumehostHost NameNetwork address of Email server (e.g., pop.gmail.com, imap.gmail.com . . .)truefalsetrueENVIRONMENTfalsefalseportPortNumeric value identifying Port of Email server (e.g., 993)truefalsetrueENVIRONMENTfalsefalseauthorization-modeAuthorization ModeHow to authorize sending email on the user's behalf.password-based-authorization-modeUse Passwordpassword-based-authorization-modeUse passwordUse OAuth2oauth-based-authorization-modeUse OAuth2 to acquire access tokentruefalsefalseNONEfalsefalseoauth2-access-token-providerOAuth2 Access Token ProviderOAuth2 service that can provide access tokens.org.apache.nifi.oauth2.OAuth2AccessTokenProviderorg.apache.nifinifi-standard-services-api-nar2.2.0truefalsefalseNONEfalsefalseauthorization-modeAuthorization Modeoauth-based-authorization-modeuserUser NameUser Name used for authentication and authorization with Email server.truefalsetrueENVIRONMENTfalsefalsepasswordPasswordPassword used for authentication and authorization with Email server.truetruetrueENVIRONMENTfalsefalseauthorization-modeAuthorization Modepassword-based-authorization-modefolderFolderEmail folder to retrieve messages from (e.g., INBOX)INBOXtruefalsetrueENVIRONMENTfalsefalsefetch.sizeFetch SizeSpecify the maximum number of Messages to fetch per call to Email Server.10truefalsetrueENVIRONMENTfalsefalsedelete.messagesDelete MessagesSpecify whether mail messages should be deleted after retrieval.falsetruetruefalsefalsetruefalsefalseNONEfalsefalseconnection.timeoutConnection timeoutThe amount of time to wait to connect to Email server30 sectruefalsetrueENVIRONMENTfalsefalsesuccessAll messages that are the are successfully received from Email server and converted to FlowFiles are routed to this relationshipfalseINPUT_FORBIDDENorg.apache.nifi.processors.email.ExtractEmailAttachmentsPROCESSORExtract attachments from a mime formatted email file, splitting them into individual flowfiles.splitemailfailureFlowFiles that could not be parsedfalseoriginalThe original filefalseattachmentsEach individual attachment will be routed to the attachments relationshipfalsefilename The filename of the attachmentemail.attachment.parent.filename The filename of the parent FlowFileemail.attachment.parent.uuidThe UUID of the original FlowFile.mime.typeThe mime type of the attachment.truetrueINPUT_REQUIREDorg.apache.nifi.processors.email.ExtractEmailHeadersPROCESSORUsing 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 2822splitemailCAPTURED_HEADERSAdditional Header ListCOLON 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.x-mailerfalsefalsefalseNONEfalsefalseSTRICT_ADDRESS_PARSINGEmail Address ParsingIf "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 ParsingtrueStrict Address ParsingtrueStrict email address format will be enforced. FlowFiles will be transfered to the failure relationship if the email address is invalid.Non-Strict Address ParsingfalseAccept emails, even if the address is poorly formed and doesn't strictly comply with RFC Validation.falsefalsefalseNONEfalsefalsesuccessExtraction was successfulfalsefailureFlowfiles that could not be parsed as a RFC-2822 compliant messagefalseemail.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-idThe value of the Message-ID header (if available)email.headers.received_dateThe Received-Date of the message (if available)email.headers.sent_dateDate the message was sentemail.headers.subjectSubject of the message (if available)email.headers.to.*Each individual TO recipient (if available)email.attachment_countNumber of attachments of the messagetruetrueINPUT_REQUIRED