Package lumis.portal.sendmail

Interface IMailSendStatus

All Known Subinterfaces:

IBaseMail, IMailDestination, IMultipleMail, ISingleMail

@StableMinor(version="17.0",
             sinceVersion="4.0")
public interface IMailSendStatus

Stores information about the sending situation of a mail.

Since:

4.0.4

Version:

$Revision$ $Date$

Field Summary

Fields

Modifier and Type	Field	Description
static int	STATUS_SEND_PENDING	Status code that indicates the sending is pending.
static int	STATUS_SENDING	Status code that indicates the sending is in progress.
static int	STATUS_SENT_ERROR	Status code that indicates the sending was tried but was unsucessful.
static int	STATUS_SENT_OK	Status code that indicates the sending was completed successfully.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getErrorMessage()	Returns the error message of the last try to send the mail.
java.util.Date	getSentDateTime()	Returns the datetime of the last try to send the mail.
int	getStatus()	Returns the status of the sending of the mail.
void	setErrorMessage(java.lang.String msg)	Sets the error message of the last try to send the mail.
void	setSentDateTime(java.util.Date sentDate)	Sets the datetime of the last try to send the mail.
void	setStatus(int status)	Sets the sending status of the mail.

Field Detail

STATUS_SEND_PENDING

static final int STATUS_SEND_PENDING

Status code that indicates the sending is pending.

Since:

4.0.4

See Also:

getStatus(), Constant Field Values

STATUS_SENDING

static final int STATUS_SENDING

Status code that indicates the sending is in progress. If this status code stays for much time may indicate the sending process was interrupted, and it is not possible to know if it was sent or not.

Since:

4.0.4

See Also:

getStatus(), Constant Field Values

STATUS_SENT_OK

static final int STATUS_SENT_OK

Status code that indicates the sending was completed successfully.

Since:

4.0.4

See Also:

getStatus(), Constant Field Values

STATUS_SENT_ERROR

static final int STATUS_SENT_ERROR

Status code that indicates the sending was tried but was unsucessful.

Since:

4.0.4

See Also:

getStatus(), getErrorMessage(), Constant Field Values

Method Detail

getSentDateTime

java.util.Date getSentDateTime()

Returns the datetime of the last try to send the mail.

Returns:

the datetime of the last try to send the mail.

Since:

4.0.4

setSentDateTime

void setSentDateTime(java.util.Date sentDate)

Sets the datetime of the last try to send the mail.

Parameters:

sentDate - the datetime value to set.

Since:

4.0.4

getStatus

int getStatus()

Returns the status of the sending of the mail.

Returns:

The status of the sending of the mail.

Since:

4.0.4

See Also:

STATUS_SEND_PENDING, STATUS_SENDING, STATUS_SENT_OK, STATUS_SENT_ERROR

setStatus

void setStatus(int status)

Sets the sending status of the mail.

Parameters:

status - the status value to set.

Since:

4.0.4

See Also:

STATUS_SEND_PENDING, STATUS_SENDING, STATUS_SENT_OK, STATUS_SENT_ERROR

getErrorMessage

java.lang.String getErrorMessage()

Returns the error message of the last try to send the mail.

Returns:

the error message of the last try to send the mail.

Since:

4.0.4

setErrorMessage

void setErrorMessage(java.lang.String msg)

Sets the error message of the last try to send the mail.

Parameters:

msg - the error message to set.

Since:

4.0.4