com.haulmont.cuba.core.app

Interface EmailerConfig

All Superinterfaces:

Config

public interface EmailerConfig
extends Config

Configuration parameters interface used for sending emails.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAdminAddress() All emails go to this address if getSendAllToAdmin() is enabled, regardless of actual recipient.
int	getDefaultSendingAttemptsCount() Max number of attempts to send a message, after which the message's status is set to NOT_SENT.
int	getDelayCallCount() How many scheduler ticks to skip after server startup.
java.lang.String	getEmailerUserLogin() User login used by asynchronous sending mechanism to be able to store information in the database.
java.lang.String	getFromAddress() Default "from" address
int	getMessageQueueCapacity() Scheduler will process no more than given number of queued messages per every scheduler tick.
boolean	getSendAllToAdmin() If this parameter is set to true, all email messages go to getAdminAddress().
int	getSendingTimeoutSec() Timeout in seconds for message in SendingStatus.SENDING status to be successfully sent or failed.
boolean	getSmtpAuthRequired() Whether to authenticate on SMTP server.
int	getSmtpConnectionTimeoutSec() SMTP connection timeout value in seconds.
java.lang.String	getSmtpHost() SMTP server address.
java.lang.String	getSmtpPassword() User password for the SMTP server authentication.
int	getSmtpPort() SMTP server port.
boolean	getSmtpSslEnabled() If set to true, use SSL to connect
boolean	getSmtpStarttlsEnable() Whether to use STARTTLS command during the SMTP server authentication.
int	getSmtpTimeoutSec() SMTP I/O timeout value in seconds.
java.lang.String	getSmtpUser() User name for the SMTP server authentication.
boolean	isFileStorageUsed() When turned on, email body text and attachments will be stored in file storage instead of BLOB columns in database.
void	setAdminAddress(java.lang.String adminAddress)
void	setDelayCallCount(int delayCallCount)
void	setFileStorageUsed(boolean fileStorageUsed)
void	setFromAddress(java.lang.String fromAddress)
void	setSendAllToAdmin(boolean sendAllToAdmin)
void	setSmtpAuthRequired(boolean smtpAuthRequired)
void	setSmtpConnectionTimeoutSec(int smtpConnectionTimeoutSec)
void	setSmtpHost(java.lang.String smtpHost)
void	setSmtpPort(int smtpPort)
void	setSmtpSslEnabled(boolean smtpSslEnabled)
void	setSmtpStarttlsEnable(boolean smtpStarttlsEnable)
void	setSmtpTimeoutSec(int smtpTimeoutSec)
void	setSmtpUser(java.lang.String smtpUser)

Method Detail

getFromAddress

@Default(value="DoNotReply@localhost")
java.lang.String getFromAddress()

Default "from" address

setFromAddress

void setFromAddress(java.lang.String fromAddress)

getSmtpHost

@Default(value="test.host")
java.lang.String getSmtpHost()

SMTP server address.

setSmtpHost

void setSmtpHost(java.lang.String smtpHost)

getSmtpPort

@Default(value="25")
int getSmtpPort()

SMTP server port.

setSmtpPort

void setSmtpPort(int smtpPort)

getSmtpAuthRequired

boolean getSmtpAuthRequired()

Whether to authenticate on SMTP server.

setSmtpAuthRequired

void setSmtpAuthRequired(boolean smtpAuthRequired)

getSmtpStarttlsEnable

boolean getSmtpStarttlsEnable()

Whether to use STARTTLS command during the SMTP server authentication.

setSmtpStarttlsEnable

void setSmtpStarttlsEnable(boolean smtpStarttlsEnable)

getSmtpUser

java.lang.String getSmtpUser()

User name for the SMTP server authentication.

setSmtpUser

void setSmtpUser(java.lang.String smtpUser)

getSmtpPassword

java.lang.String getSmtpPassword()

User password for the SMTP server authentication.

getSmtpConnectionTimeoutSec

int getSmtpConnectionTimeoutSec()

SMTP connection timeout value in seconds.

setSmtpConnectionTimeoutSec

void setSmtpConnectionTimeoutSec(int smtpConnectionTimeoutSec)

getSmtpSslEnabled

boolean getSmtpSslEnabled()

If set to true, use SSL to connect

setSmtpSslEnabled

void setSmtpSslEnabled(boolean smtpSslEnabled)

getSmtpTimeoutSec

int getSmtpTimeoutSec()

SMTP I/O timeout value in seconds.

setSmtpTimeoutSec

void setSmtpTimeoutSec(int smtpTimeoutSec)

getDelayCallCount

@Default(value="2")
int getDelayCallCount()

How many scheduler ticks to skip after server startup. Actual sending will start with the next call.
This reduces the server load on startup.

setDelayCallCount

void setDelayCallCount(int delayCallCount)

getMessageQueueCapacity

@Default(value="100")
int getMessageQueueCapacity()

Scheduler will process no more than given number of queued messages per every scheduler tick.

getDefaultSendingAttemptsCount

int getDefaultSendingAttemptsCount()

Max number of attempts to send a message, after which the message's status is set to NOT_SENT.

getSendingTimeoutSec

int getSendingTimeoutSec()

Timeout in seconds for message in SendingStatus.SENDING status to be successfully sent or failed. After this time passes, emailer will try to resend email again.

getAdminAddress

@Default(value="admin@localhost")
java.lang.String getAdminAddress()

All emails go to this address if getSendAllToAdmin() is enabled, regardless of actual recipient.

setAdminAddress

void setAdminAddress(java.lang.String adminAddress)

getSendAllToAdmin

boolean getSendAllToAdmin()

If this parameter is set to true, all email messages go to getAdminAddress().

setSendAllToAdmin

void setSendAllToAdmin(boolean sendAllToAdmin)

isFileStorageUsed

boolean isFileStorageUsed()

When turned on, email body text and attachments will be stored in file storage instead of BLOB columns in database. Should be used if application stores lots of emails and/or email attachments.

See Also:

SendingMessage.contentTextFile, SendingAttachment.contentFile

setFileStorageUsed

void setFileStorageUsed(boolean fileStorageUsed)

getEmailerUserLogin

@Default(value="admin")
java.lang.String getEmailerUserLogin()

User login used by asynchronous sending mechanism to be able to store information in the database.