Package lumis.portal.sendmail

Interface IBaseMail

All Superinterfaces:

IMailSendStatus

All Known Subinterfaces:

IMultipleMail, ISingleMail

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

Superinterface with common methods of mails interfaces.

Since:

4.0.4

Version:

$Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

See Also:

ISingleMail, IMultipleMail, ISendMailManager

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAIL_TYPE_MULTIPLE	Indicates the mail is a multiple mail, i.e.
static int	MAIL_TYPE_SINGLE	Indicates the mail is a single mail.

Fields inherited from interface lumis.portal.sendmail.IMailSendStatus

STATUS_SEND_PENDING, STATUS_SENDING, STATUS_SENT_ERROR, STATUS_SENT_OK

Method Summary

Modifier and Type	Method	Description
IMailBody	getBody()	Returns the body of this mail.
java.lang.String	getCharset()	Returns the charset of this mail.
java.lang.String	getFrom()	Returns the from field of this mail.
java.lang.String	getId()	Returns the id of this mail.
java.lang.String	getMailLoggingString()	Returns a String used for logging this mail.
int	getMailType()	Returns the type of this mail.
java.lang.String	getReplyTo()	Returns the reply to field of this mail.
java.util.Date	getRequestDateTime()	Returns the date this mail has been requested to be sent.
java.lang.String	getSourceComponent()	Returns the string describing the source component for this mail request.
java.lang.String	getSourceComponentStringsUrl()	Returns the strings url prefix for translating getSourceComponent().
java.lang.String	getSubject()	Returns the subject of this mail.
void	setCharset(java.lang.String charset)	Sets the chartset of this mail.
void	setFrom(java.lang.String from)	Sets the from field of this mail.
void	setReplyTo(java.lang.String replyTo)	Sets the reply to field of this mail.
void	setSourceComponent(java.lang.String sourceComponent)	Sets the string describing the source component for this mail request.
void	setSourceComponentStringsUrl(java.lang.String sourceComponentStrings)	Sets the strings url prefix for translating getSourceComponent().
void	setSubject(java.lang.String subject)	Sets the subject of this mail.

Methods inherited from interface lumis.portal.sendmail.IMailSendStatus

getErrorMessage, getSentDateTime, getStatus, setErrorMessage, setSentDateTime, setStatus

Field Detail

MAIL_TYPE_SINGLE

static final int MAIL_TYPE_SINGLE

Indicates the mail is a single mail.

See Also:

Constant Field Values

MAIL_TYPE_MULTIPLE

static final int MAIL_TYPE_MULTIPLE

Indicates the mail is a multiple mail, i.e. will span several other mails when sending.

See Also:

Constant Field Values

Method Detail

getRequestDateTime

java.util.Date getRequestDateTime()

Returns the date this mail has been requested to be sent. May be null, if the send request was not made yet.

Returns:

the date this mail has been requested to be sent.

Since:

4.0.4

getBody

IMailBody getBody()

Returns the body of this mail.

Returns:

the body of this mail.

Since:

4.0.4

getCharset

java.lang.String getCharset()

Returns the charset of this mail.

Returns:

the charset of this mail.

Since:

4.0.4

setCharset

void setCharset(java.lang.String charset)

Sets the chartset of this mail.

Parameters:

charset - the charset.

Since:

4.0.4

getFrom

java.lang.String getFrom()

Returns the from field of this mail.

Returns:

the from field of this mail.

Since:

4.0.4

setFrom

void setFrom(java.lang.String from)

Sets the from field of this mail.

Parameters:

from - the from field value.

Since:

4.0.4

getId

java.lang.String getId()

Returns the id of this mail. This id is a unique identifier for this mail.

Returns:

the id of this mail.

Since:

4.0.4

getReplyTo

java.lang.String getReplyTo()

Returns the reply to field of this mail. May contain a list of email addresses separated by comma.

Returns:

the reply to field of this mail.

Since:

4.0.4

setReplyTo

void setReplyTo(java.lang.String replyTo)

Sets the reply to field of this mail. May contain a list of email addresses separated by comma.

Parameters:

replyTo - the reply to field value.

Since:

4.0.4

getSubject

java.lang.String getSubject()

Returns the subject of this mail.

Returns:

the subject of this mail.

Since:

4.0.4

setSubject

void setSubject(java.lang.String subject)

Sets the subject of this mail.

Parameters:

subject - the subject value.

Since:

4.0.4

getSourceComponent

java.lang.String getSourceComponent()

Returns the string describing the source component for this mail request.

Returns:

the string describing the source component for this mail request.

Since:

4.0.4

See Also:

getSourceComponentStringsUrl()

setSourceComponent

void setSourceComponent(java.lang.String sourceComponent)

Sets the string describing the source component for this mail request.

Parameters:

sourceComponent - the string value.

Since:

4.0.4

See Also:

setSourceComponentStringsUrl(String)

getSourceComponentStringsUrl

java.lang.String getSourceComponentStringsUrl()

Returns the strings url prefix for translating getSourceComponent().

Returns:

the strings url prefix for translating getSourceComponent().

Since:

4.0.4

setSourceComponentStringsUrl

void setSourceComponentStringsUrl(java.lang.String sourceComponentStrings)

Sets the strings url prefix for translating getSourceComponent().

Parameters:

sourceComponentStrings - the value to set.

Since:

4.0.4

See Also:

setSourceComponent(String)

getMailType

int getMailType()

Returns the type of this mail.

Returns:

the type of this mail.

Since:

4.0.4

See Also:

MAIL_TYPE_SINGLE, MAIL_TYPE_MULTIPLE

getMailLoggingString

java.lang.String getMailLoggingString()

Returns a String used for logging this mail.

Returns:

the string for logging this mail.

Since:

4.0.4