org.apache.nifi.processors.standard

Class PutEmail

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.PutEmail

All Implemented Interfaces:

ConfigurableComponent, Processor

@SupportsBatching
 @Tags(value={"email","put","notify","smtp"})
 @InputRequirement(value=INPUT_REQUIRED)
 @CapabilityDescription(value="Sends an e-mail to configured recipients for each incoming FlowFile")
 @SupportsSensitiveDynamicProperties
 @DynamicProperty(name="mail.propertyName",
                 value="Value for a specific property to be set in the JavaMail Session object",
                 description="Dynamic property names that will be passed to the Mail session. Possible properties can be found in: https://javaee.github.io/javamail/docs/api/com/sun/mail/smtp/package-summary.html.",
                 expressionLanguageScope=FLOWFILE_ATTRIBUTES)
 @SystemResourceConsideration(resource=MEMORY,
                             description="The entirety of the FlowFile\'s content (as a String object) will be read into memory in case the property to use the flow file content as the email body is set to true.")
public class PutEmail
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	PutEmail.DynamicMailPropertyValidator

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ATTACH_FILE
static PropertyDescriptor	ATTRIBUTE_NAME_REGEX
private Pattern	attributeNamePattern
static PropertyDescriptor	AUTHORIZATION_MODE
static PropertyDescriptor	BCC
static String	BODY_SEPARATOR
static PropertyDescriptor	CC
static PropertyDescriptor	CONTENT_AS_MESSAGE
static PropertyDescriptor	CONTENT_TYPE
static PropertyDescriptor	FROM
static PropertyDescriptor	HEADER_XMAILER
static PropertyDescriptor	INCLUDE_ALL_ATTRIBUTES
static PropertyDescriptor	INPUT_CHARACTER_SET
private static Pattern	MAIL_PROPERTY_PATTERN
static PropertyDescriptor	MESSAGE
static AllowableValue	OAUTH_AUTHORIZATION_MODE
static PropertyDescriptor	OAUTH2_ACCESS_TOKEN_PROVIDER
private Optional<OAuth2AccessTokenProvider>	oauth2AccessTokenProviderOptional
static AllowableValue	PASSWORD_BASED_AUTHORIZATION_MODE
private List<PropertyDescriptor>	properties
private static Map<String,PropertyDescriptor>	propertyToContext Mapping of the mail properties to the NiFi PropertyDescriptors that will be evaluated at runtime
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
static PropertyDescriptor	SMTP_AUTH
static PropertyDescriptor	SMTP_HOSTNAME
static PropertyDescriptor	SMTP_PASSWORD
static PropertyDescriptor	SMTP_PORT
static PropertyDescriptor	SMTP_SOCKET_FACTORY
static PropertyDescriptor	SMTP_TLS
static PropertyDescriptor	SMTP_USERNAME
static PropertyDescriptor	SUBJECT
static PropertyDescriptor	TO

Constructor Summary

Constructors

Constructor and Description
PutEmail()

Method Summary

Modifier and Type	Method and Description
private jakarta.mail.Session	createMailSession(Properties properties) Based on the input properties, determine whether an authenticate or unauthenticated session should be used.
protected Collection<ValidationResult>	customValidate(ValidationContext context)
private static String	formatAttributes(FlowFile flowFile, String messagePrepend)
private Charset	getCharset(ProcessContext context) Utility function to get a charset from the INPUT_CHARACTER_SET property
private String	getEncoding(ProcessContext context) Utility function to get the correct encoding from the INPUT_CHARACTER_SET property
private Properties	getMailPropertiesFromFlowFile(ProcessContext context, FlowFile flowFile) Uses the mapping of javax.mail properties to NiFi PropertyDescriptors to build the required Properties object to be used for sending this email
private String	getMessage(FlowFile flowFile, ProcessContext context, ProcessSession session)
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
protected void	send(jakarta.mail.Message msg) Wrapper for static method Transport.send(Message) to add testability of this class.
private void	setMessageHeader(String header, String value, jakarta.mail.Message message)
private jakarta.mail.internet.InternetAddress[]	toInetAddresses(ProcessContext context, FlowFile flowFile, PropertyDescriptor propertyDescriptor)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

MAIL_PROPERTY_PATTERN

private static final Pattern MAIL_PROPERTY_PATTERN

SMTP_HOSTNAME

public static final PropertyDescriptor SMTP_HOSTNAME

SMTP_PORT

public static final PropertyDescriptor SMTP_PORT

PASSWORD_BASED_AUTHORIZATION_MODE

public static final AllowableValue PASSWORD_BASED_AUTHORIZATION_MODE

OAUTH_AUTHORIZATION_MODE

public static final AllowableValue OAUTH_AUTHORIZATION_MODE

AUTHORIZATION_MODE

public static final PropertyDescriptor AUTHORIZATION_MODE

OAUTH2_ACCESS_TOKEN_PROVIDER

public static final PropertyDescriptor OAUTH2_ACCESS_TOKEN_PROVIDER

SMTP_USERNAME

public static final PropertyDescriptor SMTP_USERNAME

SMTP_PASSWORD

public static final PropertyDescriptor SMTP_PASSWORD

SMTP_AUTH

public static final PropertyDescriptor SMTP_AUTH

SMTP_TLS

public static final PropertyDescriptor SMTP_TLS

SMTP_SOCKET_FACTORY

public static final PropertyDescriptor SMTP_SOCKET_FACTORY

HEADER_XMAILER

public static final PropertyDescriptor HEADER_XMAILER

ATTRIBUTE_NAME_REGEX

public static final PropertyDescriptor ATTRIBUTE_NAME_REGEX

CONTENT_TYPE

public static final PropertyDescriptor CONTENT_TYPE

FROM

public static final PropertyDescriptor FROM

TO

public static final PropertyDescriptor TO

CC

public static final PropertyDescriptor CC

BCC

public static final PropertyDescriptor BCC

SUBJECT

public static final PropertyDescriptor SUBJECT

MESSAGE

public static final PropertyDescriptor MESSAGE

ATTACH_FILE

public static final PropertyDescriptor ATTACH_FILE

CONTENT_AS_MESSAGE

public static final PropertyDescriptor CONTENT_AS_MESSAGE

INCLUDE_ALL_ATTRIBUTES

public static final PropertyDescriptor INCLUDE_ALL_ATTRIBUTES

INPUT_CHARACTER_SET

public static final PropertyDescriptor INPUT_CHARACTER_SET

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

properties

private List<PropertyDescriptor> properties

relationships

private Set<Relationship> relationships

propertyToContext

private static final Map<String,PropertyDescriptor> propertyToContext

Mapping of the mail properties to the NiFi PropertyDescriptors that will be evaluated at runtime

attributeNamePattern

private volatile Pattern attributeNamePattern

oauth2AccessTokenProviderOptional

private volatile Optional<OAuth2AccessTokenProvider> oauth2AccessTokenProviderOptional

BODY_SEPARATOR

public static final String BODY_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

PutEmail

public PutEmail()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext context)

Overrides:

customValidate in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

setMessageHeader

private void setMessageHeader(String header,
                              String value,
                              jakarta.mail.Message message)
                       throws jakarta.mail.MessagingException

Throws:

jakarta.mail.MessagingException

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor

getMessage

private String getMessage(FlowFile flowFile,
                          ProcessContext context,
                          ProcessSession session)

createMailSession

private jakarta.mail.Session createMailSession(Properties properties)

Based on the input properties, determine whether an authenticate or unauthenticated session should be used. If authenticated, creates a Password Authenticator for use in sending the email.

Parameters:

properties - mail properties

Returns:

session

getMailPropertiesFromFlowFile

private Properties getMailPropertiesFromFlowFile(ProcessContext context,
                                                 FlowFile flowFile)

Uses the mapping of javax.mail properties to NiFi PropertyDescriptors to build the required Properties object to be used for sending this email

Parameters:

context - context

flowFile - flowFile

Returns:

mail properties

formatAttributes

private static String formatAttributes(FlowFile flowFile,
                                       String messagePrepend)

toInetAddresses

private jakarta.mail.internet.InternetAddress[] toInetAddresses(ProcessContext context,
                                                                FlowFile flowFile,
                                                                PropertyDescriptor propertyDescriptor)
                                                         throws jakarta.mail.internet.AddressException

Parameters:

context - the current context

flowFile - the current flow file

propertyDescriptor - the property to evaluate

Returns:

an InternetAddress[] parsed from the supplied property

Throws:

jakarta.mail.internet.AddressException - if the property cannot be parsed to a valid InternetAddress[]

send

protected void send(jakarta.mail.Message msg)
             throws jakarta.mail.MessagingException

Wrapper for static method Transport.send(Message) to add testability of this class.

Parameters:

msg - the message to send

Throws:

jakarta.mail.MessagingException - on error

getCharset

private Charset getCharset(ProcessContext context)

Utility function to get a charset from the INPUT_CHARACTER_SET property

Parameters:

context - the ProcessContext

Returns:

the Charset

getEncoding

private String getEncoding(ProcessContext context)

Utility function to get the correct encoding from the INPUT_CHARACTER_SET property

Parameters:

context - the ProcessContext

Returns:

the encoding