de.uplanet.lucy.mail

Interface ISendMailConfiguration

public interface ISendMailConfiguration

Version:

$Revision: 180214 $

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBadMailDirectory() Get the directory where mails that could not be sent are archived.
java.lang.String	getCommandDirectory() Get the directory where commands can be passed to the send-mail service.
java.lang.String	getDefaultSenderAddress() Get the address of the default sender.
java.lang.String	getDefaultSenderName() Get the name of the default sender.
long	getFirstRetryInterval()
java.lang.String	getFixedRecipientAddress() Get an optional fixed recipient address.
long	getLimitMaxMailFileSize() Get the approximate maximum size of a message that can be sent.
int	getLimitMaxSentMessagesPerSession() Get the maximum number of messages that can be sent before a new SMTP session is being established.
int	getMaxRetriesCount()
java.lang.String	getPassword() Get the password used for SMTP authentication.
java.lang.String	getPickupDirectory() Get the pickup mail directory, i.e.
java.lang.String	getProtocol() Get the protocol that is used to send mail, i.e.
java.lang.String	getQueueDirectory() Get the directory where mails are queued for delivery.
long	getSecondRetryInterval()
java.util.Map<java.lang.String,java.lang.String>	getSendMailProperties() Get the send-mail properties.
java.lang.String	getSentMailDirectory() Get the directory where mails that have been sent are archived if archiveSentMail is true.
long	getSleepInterval() An internally used sleep interval.
java.lang.String	getSmtpHost() Get the SMTP host that is used for sending mail.
int	getSmtpPort() Get the SMTP port used for sending mail.
java.util.Map<java.lang.String,java.lang.String>	getSmtpProviderProperties() Get the SMTP provider properties.
long	getSubsequentRetryInterval()
java.lang.String	getTemporaryDirectory() Get the temporary mail directory, i.e.
long	getThirdRetryInterval()
java.lang.String	getUser() Get the user name used for SMTP authentication.
boolean	isArchiveSentMail() This property determines if sent mail should be archived in the sentMailDirectory.
boolean	isLogSuccess() This property determines if sending success should be logged.
boolean	isLogSuccessSubject() This property determines if sending success should be logged with the message subject.
boolean	isSendBadMailWorkflowEvent() This property determines a workflow event should be sent if a mail could not be sent and has been moved to the archive for unsent mail.
boolean	isUsesAuthentication() This property determines if the SMTP server needs authentication.

Method Detail

getDefaultSenderAddress

java.lang.String getDefaultSenderAddress()

Get the address of the default sender.

Returns:

The address of the default sender.

getDefaultSenderName

java.lang.String getDefaultSenderName()

Get the name of the default sender.

Returns:

The name of the default sender.

getSleepInterval

long getSleepInterval()

An internally used sleep interval.

Returns:

The internally used sleep interval.

getTemporaryDirectory

java.lang.String getTemporaryDirectory()

Get the temporary mail directory, i.e. the directory the mails files are being created.

See de.uplanet.lucy.sendmail.pickupDirectory.

Returns:

The temporary mail directory.

getPickupDirectory

java.lang.String getPickupDirectory()

Get the pickup mail directory, i.e. the directory where mails are passed over to the send-mail service.

See de.uplanet.lucy.sendmail.temporaryDirectory.

Returns:

The pickup directory.

getQueueDirectory

java.lang.String getQueueDirectory()

Get the directory where mails are queued for delivery.

See de.uplanet.lucy.sendmail.queueDirectory.

Returns:

The queue directory.

getBadMailDirectory

java.lang.String getBadMailDirectory()

Get the directory where mails that could not be sent are archived.

See de.uplanet.lucy.sendmail.badMailDirectory.

Returns:

The archive directory for mail that could not be sent.

getSentMailDirectory

java.lang.String getSentMailDirectory()

Get the directory where mails that have been sent are archived if archiveSentMail is true.

See de.uplanet.lucy.sendmail.sentMailDirectory.

Returns:

The archive directory for sent mail.

getCommandDirectory

java.lang.String getCommandDirectory()

Get the directory where commands can be passed to the send-mail service.

See de.uplanet.lucy.sendmail.commandDirectory.

Returns:

The command directory.

isArchiveSentMail

boolean isArchiveSentMail()

This property determines if sent mail should be archived in the sentMailDirectory.

See de.uplanet.lucy.sendmail.archiveSentMail.

Returns:

true if sent mails should be archived, or false otherwise.

getProtocol

java.lang.String getProtocol()

Get the protocol that is used to send mail, i.e. either smtp, or smtps.

Returns:

The protocol used to send mail.

isUsesAuthentication

boolean isUsesAuthentication()

This property determines if the SMTP server needs authentication.

Returns:

true if the SMTP server needs authentication, or false otherwise.

getUser

java.lang.String getUser()

Get the user name used for SMTP authentication.

Returns:

The user name used for SMTP authentication.

getPassword

java.lang.String getPassword()

Get the password used for SMTP authentication.

Returns:

The password used for SMTP authentication.

getSendMailProperties

java.util.Map<java.lang.String,java.lang.String> getSendMailProperties()

Get the send-mail properties.

Returns:

The send-mail properties.

getSmtpProviderProperties

java.util.Map<java.lang.String,java.lang.String> getSmtpProviderProperties()

Get the SMTP provider properties.

The property names start with mail.smtp. if SMTP is used, and mail.smtps. if SMTPS is used.

Returns:

The SMTP provider properties.

getSmtpHost

java.lang.String getSmtpHost()

Get the SMTP host that is used for sending mail.

Returns:

The SMTP host.

getSmtpPort

int getSmtpPort()

Get the SMTP port used for sending mail.

Returns:

The SMTP port.

getLimitMaxSentMessagesPerSession

int getLimitMaxSentMessagesPerSession()

Get the maximum number of messages that can be sent before a new SMTP session is being established.

See de.uplanet.lucy.sendmail.limit.maxMailsPerSession.

Returns:

The limit.

getLimitMaxMailFileSize

long getLimitMaxMailFileSize()

Get the approximate maximum size of a message that can be sent.

See de.uplanet.lucy.sendmail.limit.maxMailFileSize.

Returns:

The approximate maximum size of a message.

getFixedRecipientAddress

java.lang.String getFixedRecipientAddress()

Get an optional fixed recipient address.

If this recipient address is specified, all e-mails will be sent to this recipient regardless of the addresses specified in the To, Cc, and Bcc header fields.

See de.uplanet.lucy.sendmail.fixedRecipientAddress.

Returns:

The fixed recipient address, or null.

getMaxRetriesCount

int getMaxRetriesCount()

getFirstRetryInterval

long getFirstRetryInterval()

getSecondRetryInterval

long getSecondRetryInterval()

getThirdRetryInterval

long getThirdRetryInterval()

getSubsequentRetryInterval

long getSubsequentRetryInterval()

isLogSuccess

boolean isLogSuccess()

This property determines if sending success should be logged.

See de.uplanet.lucy.sendmail.logging.logSuccess.

Returns:

true if sending success should be logged, or false otherwise.

isLogSuccessSubject

boolean isLogSuccessSubject()

This property determines if sending success should be logged with the message subject.

See de.uplanet.lucy.sendmail.logging.logSuccess.subject.

Returns:

true if sending success should be logged with the message subject, or false otherwise.

isSendBadMailWorkflowEvent

boolean isSendBadMailWorkflowEvent()

This property determines a workflow event should be sent if a mail could not be sent and has been moved to the archive for unsent mail.

See de.uplanet.lucy.sendmail.workflow.sendBadMailEvent.

Returns:

true if a workflow event should be sent, or false otherwise.