Class EmailProducerConfiguration
- java.lang.Object
-
- org.ikasan.component.endpoint.email.producer.EmailProducerConfiguration
-
public class EmailProducerConfiguration extends java.lang.ObjectEmail Producer Configuration- Author:
- Ikasan Development Team
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.List<java.lang.String>bccRecipientsbcc recipientsprotected java.util.List<java.lang.String>ccRecipientscc recipientsprotected java.lang.StringemailBodyemail contentprotected java.lang.StringemailFormatemail format, e.g.protected java.util.Map<java.lang.String,java.lang.String>extendedMailSessionPropertiesproperties to be configured on creation of the mail sessionprotected booleanhasAttachmentflag for attachmentprotected booleanmailDebugThe initial debug mode.protected java.lang.StringmailFromThe return email address of the current user, used by the InternetAddress method getLocalAddress.protected java.lang.StringmailHostThe default host name of the mail server for both Stores and Transports.protected booleanmailMimeAddressStrictThe MimeMessage class uses the InternetAddress method parseHeader to parse headers in messages.protected java.lang.StringmailPopClassSpecifies the fully qualified class name of the provider for the specified protocol.protected java.lang.StringmailPopHostThe host name of the mail server for the specified protocol.protected intmailPopPortThe port number of the mail server for the specified protocol.protected java.lang.StringmailPopUserThe user name to use when connecting to mail servers using the specified protocol.protected java.lang.StringmailSmtpClassSpecifies the fully qualified class name of the provider for the specified protocol.protected java.lang.StringmailSmtpHostThe host name of the mail server for the specified protocol.protected intmailSmtpPortThe port number of the mail server for the specified protocol.protected java.lang.StringmailSmtpUserThe user name to use when connecting to mail servers using the specified protocol.protected java.lang.StringmailStoreProtocolThe default host name of the mail server for both Stores and Transports By default the first Store provider in the configuration files is returned.protected java.lang.StringmailTransportProtocolThe default host name of the mail server for both Stores and Transports By defaultprotected java.lang.Stringpasswordemail format, e.g.protected java.lang.StringruntimeEnvironmentprotected java.lang.Stringsubjectsubject line contentprotected java.util.List<java.lang.String>toRecipientsto recipientsprotected java.lang.StringuserThe default user name to use when connecting to the mail server.
-
Constructor Summary
Constructors Constructor Description EmailProducerConfiguration()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<java.lang.String>getBccRecipients()java.util.List<java.lang.String>getCcRecipients()java.lang.StringgetEmailBody()java.lang.StringgetEmailFormat()java.util.Map<java.lang.String,java.lang.String>getExtendedMailSessionProperties()booleangetMailDebug()java.lang.StringgetMailFrom()java.lang.StringgetMailHost()booleangetMailMimeAddressStrict()java.lang.StringgetMailPopClass()java.lang.StringgetMailPopHost()intgetMailPopPort()java.lang.StringgetMailPopUser()java.lang.StringgetMailSmtpClass()java.lang.StringgetMailSmtpHost()intgetMailSmtpPort()java.lang.StringgetMailSmtpUser()java.lang.StringgetMailStoreProtocol()java.lang.StringgetMailTransportProtocol()java.lang.StringgetPassword()java.lang.StringgetRuntimeEnvironment()java.lang.StringgetSubject()java.util.List<java.lang.String>getToRecipients()java.lang.StringgetUser()booleanisHasAttachment()booleanisMailDebug()booleanisMailMimeAddressStrict()voidsetBccRecipients(java.util.List<java.lang.String> bccRecipients)voidsetCcRecipients(java.util.List<java.lang.String> ccRecipients)voidsetEmailBody(java.lang.String emailBody)voidsetEmailFormat(java.lang.String emailFormat)voidsetExtendedMailSessionProperties(java.util.Map<java.lang.String,java.lang.String> extendedMailSessionProperties)voidsetHasAttachment(boolean hasAttachment)voidsetMailDebug(boolean mailDebug)voidsetMailFrom(java.lang.String mailFrom)voidsetMailHost(java.lang.String mailHost)voidsetMailMimeAddressStrict(boolean mailMimeAddressStrict)voidsetMailPopClass(java.lang.String mailPopClass)voidsetMailPopHost(java.lang.String mailPopHost)voidsetMailPopPort(int mailPopPort)voidsetMailPopUser(java.lang.String mailPopUser)voidsetMailSmtpClass(java.lang.String mailSmtpClass)voidsetMailSmtpHost(java.lang.String mailSmtpHost)voidsetMailSmtpPort(int mailSmtpPort)voidsetMailSmtpUser(java.lang.String mailSmtpUser)voidsetMailStoreProtocol(java.lang.String mailStoreProtocol)voidsetMailTransportProtocol(java.lang.String mailTransportProtocol)voidsetPassword(java.lang.String password)voidsetRuntimeEnvironment(java.lang.String runtimeEnvironment)voidsetSubject(java.lang.String subject)voidsetToRecipients(java.util.List<java.lang.String> toRecipients)voidsetUser(java.lang.String user)
-
-
-
Field Detail
-
extendedMailSessionProperties
protected java.util.Map<java.lang.String,java.lang.String> extendedMailSessionProperties
properties to be configured on creation of the mail session
-
mailDebug
protected boolean mailDebug
The initial debug mode. Default is false.
-
mailFrom
protected java.lang.String mailFrom
The return email address of the current user, used by the InternetAddress method getLocalAddress.
-
mailMimeAddressStrict
protected boolean mailMimeAddressStrict
The MimeMessage class uses the InternetAddress method parseHeader to parse headers in messages. This property controls the strict flag passed to the parseHeader method. The default is true.
-
mailHost
protected java.lang.String mailHost
The default host name of the mail server for both Stores and Transports. Used if the mail.protocol.host property isn't set.
-
mailStoreProtocol
protected java.lang.String mailStoreProtocol
The default host name of the mail server for both Stores and Transports By default the first Store provider in the configuration files is returned.
-
mailTransportProtocol
protected java.lang.String mailTransportProtocol
The default host name of the mail server for both Stores and Transports By default
-
user
protected java.lang.String user
The default user name to use when connecting to the mail server. Used if the mail.protocol.user property isn't set.
-
mailSmtpClass
protected java.lang.String mailSmtpClass
Specifies the fully qualified class name of the provider for the specified protocol. Used in cases where more than one provider for a given protocol exists; this property can be used to specify which provider to use by default. The provider must still be listed in a configuration file.
-
mailSmtpHost
protected java.lang.String mailSmtpHost
The host name of the mail server for the specified protocol. Overrides the mail.host property.
-
mailSmtpPort
protected int mailSmtpPort
The port number of the mail server for the specified protocol. If not specified the protocol's default port number is used.
-
mailSmtpUser
protected java.lang.String mailSmtpUser
The user name to use when connecting to mail servers using the specified protocol. Overrides the mail.user property.
-
mailPopClass
protected java.lang.String mailPopClass
Specifies the fully qualified class name of the provider for the specified protocol. Used in cases where more than one provider for a given protocol exists; this property can be used to specify which provider to use by default. The provider must still be listed in a configuration file.
-
mailPopHost
protected java.lang.String mailPopHost
The host name of the mail server for the specified protocol. Overrides the mail.host property.
-
mailPopPort
protected int mailPopPort
The port number of the mail server for the specified protocol. If not specified the protocol's default port number is used.
-
mailPopUser
protected java.lang.String mailPopUser
The user name to use when connecting to mail servers using the specified protocol. Overrides the mail.user property.
-
subject
protected java.lang.String subject
subject line content
-
runtimeEnvironment
protected java.lang.String runtimeEnvironment
-
emailBody
protected java.lang.String emailBody
email content
-
emailFormat
protected java.lang.String emailFormat
email format, e.g. plain text, html
-
password
protected java.lang.String password
email format, e.g. plain text, html
-
toRecipients
protected java.util.List<java.lang.String> toRecipients
to recipients
-
ccRecipients
protected java.util.List<java.lang.String> ccRecipients
cc recipients
-
bccRecipients
protected java.util.List<java.lang.String> bccRecipients
bcc recipients
-
hasAttachment
protected boolean hasAttachment
flag for attachment
-
-
Method Detail
-
getPassword
public java.lang.String getPassword()
-
setPassword
public void setPassword(java.lang.String password)
-
getMailSmtpClass
public java.lang.String getMailSmtpClass()
-
setMailSmtpClass
public void setMailSmtpClass(java.lang.String mailSmtpClass)
-
getMailSmtpHost
public java.lang.String getMailSmtpHost()
-
setMailSmtpHost
public void setMailSmtpHost(java.lang.String mailSmtpHost)
-
getMailSmtpPort
public int getMailSmtpPort()
-
setMailSmtpPort
public void setMailSmtpPort(int mailSmtpPort)
-
getMailSmtpUser
public java.lang.String getMailSmtpUser()
-
setMailSmtpUser
public void setMailSmtpUser(java.lang.String mailSmtpUser)
-
getMailPopClass
public java.lang.String getMailPopClass()
-
setMailPopClass
public void setMailPopClass(java.lang.String mailPopClass)
-
getMailPopHost
public java.lang.String getMailPopHost()
-
setMailPopHost
public void setMailPopHost(java.lang.String mailPopHost)
-
getMailPopPort
public int getMailPopPort()
-
setMailPopPort
public void setMailPopPort(int mailPopPort)
-
getMailPopUser
public java.lang.String getMailPopUser()
-
setMailPopUser
public void setMailPopUser(java.lang.String mailPopUser)
-
isMailDebug
public boolean isMailDebug()
-
getMailDebug
public boolean getMailDebug()
-
setMailDebug
public void setMailDebug(boolean mailDebug)
-
getMailFrom
public java.lang.String getMailFrom()
-
setMailFrom
public void setMailFrom(java.lang.String mailFrom)
-
isMailMimeAddressStrict
public boolean isMailMimeAddressStrict()
-
getMailMimeAddressStrict
public boolean getMailMimeAddressStrict()
-
setMailMimeAddressStrict
public void setMailMimeAddressStrict(boolean mailMimeAddressStrict)
-
getMailHost
public java.lang.String getMailHost()
-
getMailStoreProtocol
public java.lang.String getMailStoreProtocol()
-
setMailStoreProtocol
public void setMailStoreProtocol(java.lang.String mailStoreProtocol)
-
getMailTransportProtocol
public java.lang.String getMailTransportProtocol()
-
setMailTransportProtocol
public void setMailTransportProtocol(java.lang.String mailTransportProtocol)
-
getUser
public java.lang.String getUser()
-
setUser
public void setUser(java.lang.String user)
-
getExtendedMailSessionProperties
public java.util.Map<java.lang.String,java.lang.String> getExtendedMailSessionProperties()
-
setExtendedMailSessionProperties
public void setExtendedMailSessionProperties(java.util.Map<java.lang.String,java.lang.String> extendedMailSessionProperties)
-
setMailHost
public void setMailHost(java.lang.String mailHost)
-
getSubject
public java.lang.String getSubject()
-
setSubject
public void setSubject(java.lang.String subject)
-
getToRecipients
public java.util.List<java.lang.String> getToRecipients()
-
setToRecipients
public void setToRecipients(java.util.List<java.lang.String> toRecipients)
-
getCcRecipients
public java.util.List<java.lang.String> getCcRecipients()
-
setCcRecipients
public void setCcRecipients(java.util.List<java.lang.String> ccRecipients)
-
getBccRecipients
public java.util.List<java.lang.String> getBccRecipients()
-
setBccRecipients
public void setBccRecipients(java.util.List<java.lang.String> bccRecipients)
-
isHasAttachment
public boolean isHasAttachment()
- Returns:
- the hasAttachment
-
setHasAttachment
public void setHasAttachment(boolean hasAttachment)
- Parameters:
hasAttachment- the hasAttachment to set
-
getRuntimeEnvironment
public java.lang.String getRuntimeEnvironment()
-
setRuntimeEnvironment
public void setRuntimeEnvironment(java.lang.String runtimeEnvironment)
-
setEmailBody
public void setEmailBody(java.lang.String emailBody)
-
setEmailFormat
public void setEmailFormat(java.lang.String emailFormat)
-
getEmailBody
public java.lang.String getEmailBody()
-
getEmailFormat
public java.lang.String getEmailFormat()
-
-