jodd.mail

Class CommonEmail

java.lang.Object

jodd.mail.CommonEmail

Direct Known Subclasses:

Email, ReceivedEmail

public abstract class CommonEmail
extends java.lang.Object

Common stuff for both Email and ReceivedEmail

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	bcc
protected java.lang.String[]	cc
protected java.lang.String	from
protected java.util.Map<java.lang.String,java.lang.String>	headers
protected java.util.List<EmailMessage>	messages
static int	PRIORITY_HIGH
static int	PRIORITY_HIGHEST
static int	PRIORITY_LOW
static int	PRIORITY_LOWEST
static int	PRIORITY_NORMAL
protected java.lang.String[]	replyTo
protected java.util.Date	sentDate
protected java.lang.String	subject
protected java.lang.String[]	to
static java.lang.String	X_PRIORITY

Constructor Summary

Constructors

Constructor and Description
CommonEmail()

Method Summary

Methods

Modifier and Type	Method and Description
void	addMessage(EmailMessage emailMessage)
void	addMessage(java.lang.String text, java.lang.String mimeType)
void	addMessage(java.lang.String text, java.lang.String mimeType, java.lang.String encoding)
protected java.util.Map<java.lang.String,java.lang.String>	getAllHeaders() Returns all headers as a HashMap.
java.util.List<EmailMessage>	getAllMessages() Returns all messages.
java.lang.String[]	getBcc() Returns BCC addresses.
java.lang.String[]	getCc() Returns CC addresses.
java.lang.String	getFrom() Returns FROM address.
java.lang.String	getHeader(java.lang.String name)
int	getPriority() Returns emails priority (1 - 5) or -1 if priority not available.
java.lang.String[]	getReplyTo() Returns REPLY-TO addresses.
java.util.Date	getSentDate() Returns e-mails sent date.
java.lang.String	getSubject() Returns message subject.
java.lang.String[]	getTo() Returns TO addresses.
void	setBcc(java.lang.String... bccs) Sets BCC addresses.
void	setCc(java.lang.String... ccs) Sets CC addresses.
void	setFrom(java.lang.String from) Sets the FROM address.
void	setHeader(java.lang.String name, java.lang.String value) Sets a new header value.
void	setPriority(int priority) Sets email priority.
void	setReplyTo(java.lang.String... replyTo) Sets REPLY-TO addresses.
void	setSentDate(java.util.Date date) Sets e-mails sent date.
void	setSubject(java.lang.String subject) Sets message subject.
void	setTo(java.lang.String... tos) Sets TO addresses.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

X_PRIORITY

public static final java.lang.String X_PRIORITY

See Also:

Constant Field Values

PRIORITY_HIGHEST

public static final int PRIORITY_HIGHEST

See Also:

Constant Field Values

PRIORITY_HIGH

public static final int PRIORITY_HIGH

See Also:

Constant Field Values

PRIORITY_NORMAL

public static final int PRIORITY_NORMAL

See Also:

Constant Field Values

PRIORITY_LOW

public static final int PRIORITY_LOW

See Also:

Constant Field Values

PRIORITY_LOWEST

public static final int PRIORITY_LOWEST

See Also:

Constant Field Values

from

protected java.lang.String from

to

protected java.lang.String[] to

replyTo

protected java.lang.String[] replyTo

cc

protected java.lang.String[] cc

bcc

protected java.lang.String[] bcc

subject

protected java.lang.String subject

messages

protected java.util.List<EmailMessage> messages

headers

protected java.util.Map<java.lang.String,java.lang.String> headers

sentDate

protected java.util.Date sentDate

Constructor Detail

CommonEmail

public CommonEmail()

Method Detail

setFrom

public void setFrom(java.lang.String from)

Sets the FROM address. Address may be specified with personal information like this: "Name <email>.

getFrom

public java.lang.String getFrom()

Returns FROM address. Address may be specified with personal information like this: "Name <email>.

setTo

public void setTo(java.lang.String... tos)

Sets TO addresses. Addresses may be specified with personal information like this: "Name <email>.

getTo

public java.lang.String[] getTo()

Returns TO addresses. Address may be specified with personal information like this: "Name <email>.

setReplyTo

public void setReplyTo(java.lang.String... replyTo)

Sets REPLY-TO addresses. Address may be specified with personal information like this: "Name <email>.

getReplyTo

public java.lang.String[] getReplyTo()

Returns REPLY-TO addresses.

setCc

public void setCc(java.lang.String... ccs)

Sets CC addresses.

getCc

public java.lang.String[] getCc()

Returns CC addresses.

setBcc

public void setBcc(java.lang.String... bccs)

Sets BCC addresses.

getBcc

public java.lang.String[] getBcc()

Returns BCC addresses.

setSubject

public void setSubject(java.lang.String subject)

Sets message subject.

getSubject

public java.lang.String getSubject()

Returns message subject.

getAllMessages

public java.util.List<EmailMessage> getAllMessages()

Returns all messages.

addMessage

public void addMessage(EmailMessage emailMessage)

addMessage

public void addMessage(java.lang.String text,
              java.lang.String mimeType,
              java.lang.String encoding)

addMessage

public void addMessage(java.lang.String text,
              java.lang.String mimeType)

getAllHeaders

protected java.util.Map<java.lang.String,java.lang.String> getAllHeaders()

Returns all headers as a HashMap.

setHeader

public void setHeader(java.lang.String name,
             java.lang.String value)

Sets a new header value.

getHeader

public java.lang.String getHeader(java.lang.String name)

setPriority

public void setPriority(int priority)

Sets email priority. Values of 1 through 5 are acceptable, with 1 being the highest priority, 3 = normal and 5 = lowest priority.

getPriority

public int getPriority()

Returns emails priority (1 - 5) or -1 if priority not available.

See Also:

setPriority(int)

setSentDate

public void setSentDate(java.util.Date date)

Sets e-mails sent date. If input parameter is null then date will be when email is physically sent.

getSentDate

public java.util.Date getSentDate()

Returns e-mails sent date. If return value is null then date will be set during the process of sending.

Returns:

email's sent date or null if it will be set later.