jodd.mail

Class CommonEmail<T extends CommonEmail<T>>

java.lang.Object

jodd.mail.CommonEmail<T>

Direct Known Subclasses:

Email, ReceivedEmail

public abstract class CommonEmail<T extends CommonEmail<T>>
extends java.lang.Object

Common stuff for both Email and ReceivedEmail.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PRIORITY_HIGH
static int	PRIORITY_HIGHEST
static int	PRIORITY_LOW
static int	PRIORITY_LOWEST
static int	PRIORITY_NORMAL
static java.lang.String	X_PRIORITY

Constructor Summary

Constructors

Constructor and Description
CommonEmail()

Method Summary

Modifier and Type	Method and Description
protected T	_this()
T	attachment(EmailAttachment<? extends jakarta.activation.DataSource> attachment) Adds EmailAttachment.
T	attachment(EmailAttachmentBuilder builder)
java.util.List<EmailAttachment<? extends jakarta.activation.DataSource>>	attachments() Returns the list of all EmailAttachments.
T	attachments(java.util.List<EmailAttachment<? extends jakarta.activation.DataSource>> attachments) Adds EmailAttachments.
EmailAddress[]	cc() Returns CC addresses.
T	cc(jakarta.mail.Address... ccs) Sets one or more CC address.
T	cc(jakarta.mail.Address cc) Appends CC address.
T	cc(EmailAddress... ccs) Appends CC addresses.
T	cc(EmailAddress to) Appends CC address.
T	cc(java.lang.String... ccs) Sets one or more CC address.
T	cc(java.lang.String cc) Appends CC address.
T	cc(java.lang.String personalName, java.lang.String cc) Appends CC address.
abstract T	clone() Clones the email with all its necessary data.
T	embeddedAttachment(EmailAttachment<? extends jakarta.activation.DataSource> attachment) Embed EmailAttachment to last message.
T	embeddedAttachment(EmailAttachmentBuilder builder) Attaches the embedded attachment: Content ID will be set if missing from attachment's file name.
EmailAddress	from() Returns FROM EmailAddress.
T	from(jakarta.mail.Address from) Sets the FROM address from Address.
T	from(EmailAddress from) Sets the FROM address.
T	from(java.lang.String from) Sets the FROM address.
T	from(java.lang.String personalName, java.lang.String from) Sets the FROM address by providing personal name and address.
java.lang.String	header(java.lang.String name) Returns the value of a header.
T	header(java.lang.String name, java.lang.String value) Sets header value.
protected java.util.Map<java.lang.String,java.lang.String>	headers() Returns all headers as a HashMap.
T	headers(java.util.Enumeration<jakarta.mail.Header> headersToSet) Sets headers.
T	headers(java.util.Map<java.lang.String,java.lang.String> headersToSet) Sets headers.
T	htmlMessage(java.lang.String html) Adds HTML message.
T	htmlMessage(java.lang.String html, java.lang.String encoding) Adds HTML message.
T	message(EmailMessage msgToAdd) Adds an EmailMessage.
T	message(java.util.List<EmailMessage> msgsToAdd) Adds multiple messages.
T	message(java.lang.String text, java.lang.String mimeType) Adds a EmailMessage.
T	message(java.lang.String text, java.lang.String mimeType, java.lang.String encoding) Adds a EmailMessage.
java.util.List<EmailMessage>	messages() Returns all messages.
int	priority() Returns emails priority (1 - 5) or -1 if priority not available.
T	priority(int priority) Sets email priority.
EmailAddress[]	replyTo() Returns REPLY-TO addresses.
T	replyTo(jakarta.mail.Address... replyTos) Appeds one or more REPLY-TO address.
T	replyTo(jakarta.mail.Address replyTo) Appends REPLY-TO address.
T	replyTo(EmailAddress... replyTo) Appends REPLY-TO addresses.
T	replyTo(EmailAddress replyTo) Appends REPLY-TO address.
T	replyTo(java.lang.String... replyTos) Appends one or more REPLY-TO address.
T	replyTo(java.lang.String replyTo) Appends REPLY-TO address.
T	replyTo(java.lang.String personalName, java.lang.String replyTo) Appends REPLY-TO address.
T	resetCc() Resets all CC addresses.
T	resetReplyTo() Resets all REPLY-To addresses.
T	resetTo() Resets TO addresses.
java.util.Date	sentDate() Returns email's sent date.
T	sentDate(java.util.Date date) Sets email's sent date.
protected T	storeAttachment(EmailAttachment<? extends jakarta.activation.DataSource> attachment) Adds EmailAttachment.
protected T	storeAttachments(java.util.List<EmailAttachment<? extends jakarta.activation.DataSource>> attachments) Adds EmailAttachments.
java.lang.String	subject() Returns message subject.
T	subject(java.lang.String subject) Sets message subject.
T	subject(java.lang.String subject, java.lang.String encoding) Sets message subject with specified encoding to override default platform encoding.
java.lang.String	subjectEncoding() Returns the message subject encoding.
T	textMessage(java.lang.String text) Adds plain message text.
T	textMessage(java.lang.String text, java.lang.String encoding) Adds plain message text.
EmailAddress[]	to() Returns TO addresses.
T	to(jakarta.mail.Address... tos) Appends one or more TO addresses.
T	to(jakarta.mail.Address to) Appends TO address from Address.
T	to(EmailAddress... tos) Appends TO addresses.
T	to(EmailAddress to) Appends TO address.
T	to(java.lang.String... tos) Appends one or more TO address.
T	to(java.lang.String to) Appends TO address.
T	to(java.lang.String personalName, java.lang.String to) Appends TO address by personal name and email address.
java.lang.String	toString()
protected EmailAddress[]	valueOrEmptyArray(EmailAddress[] arr)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, 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

Constructor Detail

CommonEmail

public CommonEmail()

Method Detail

_this

protected T _this()

clone

public abstract T clone()

Clones the email with all its necessary data.

Overrides:

clone in class java.lang.Object

Returns:

new object of type T

from

public T from(EmailAddress from)

Sets the FROM address.

Parameters:

from - EmailAddress.

Returns:

this

from

public T from(jakarta.mail.Address from)

Sets the FROM address from Address.

Parameters:

from - Address

Returns:

this

See Also:

from(EmailAddress)

from

public T from(java.lang.String from)

Sets the FROM address.

Parameters:

from - Address may be specified with personal name like this: Jenny Doe <email@foo.com>.

Returns:

this

See Also:

from(EmailAddress)

from

public T from(java.lang.String personalName,
              java.lang.String from)

Sets the FROM address by providing personal name and address.

Parameters:

personalName - personal name.

from - email address.

Returns:

this

See Also:

from(EmailAddress)

from

public EmailAddress from()

Returns FROM EmailAddress.

to

public T to(EmailAddress to)

Appends TO address.

Parameters:

to - EmailAddress to add.

Returns:

this

to

public T to(java.lang.String to)

Appends TO address.

Parameters:

to - Address may be specified with personal name like this: Jenny Doe <email@foo.com>.

Returns:

this

See Also:

to(EmailAddress)

to

public T to(java.lang.String personalName,
            java.lang.String to)

Appends TO address by personal name and email address.

Parameters:

personalName - personal name.

to - email address.

Returns:

this

See Also:

to(EmailAddress)

to

public T to(jakarta.mail.Address to)

Appends TO address from Address.

Parameters:

to - Address to add.

Returns:

this

See Also:

to(EmailAddress)

to

public T to(java.lang.String... tos)

Appends one or more TO address.

Parameters:

tos - Address may be specified with personal name like this: Jenny Doe <email@foo.com>.

Returns:

this

See Also:

to(EmailAddress...)

to

public T to(jakarta.mail.Address... tos)

Appends one or more TO addresses.

Parameters:

tos - array of Addresss to set.

Returns:

this

See Also:

to(EmailAddress...)

to

public T to(EmailAddress... tos)

Appends TO addresses.

Parameters:

tos - vararg of EmailAddresses to set.

Returns:

this

to

public EmailAddress[] to()

Returns TO addresses.

resetTo

public T resetTo()

Resets TO addresses.

replyTo

public T replyTo(EmailAddress replyTo)

Appends REPLY-TO address.

Parameters:

replyTo - EmailAddress to add.

Returns:

this

replyTo

public T replyTo(java.lang.String replyTo)

Appends REPLY-TO address.

Parameters:

replyTo - Address may be specified with personal name like this: Jenny Doe <email@foo.com>.

Returns:

this

See Also:

replyTo(EmailAddress)

replyTo

public T replyTo(java.lang.String personalName,
                 java.lang.String replyTo)

Appends REPLY-TO address.

Parameters:

personalName - personal name.

replyTo - email address.

Returns:

this

See Also:

replyTo(EmailAddress)

replyTo

public T replyTo(jakarta.mail.Address replyTo)

Appends REPLY-TO address.

Parameters:

replyTo - Address to add.

Returns:

this

See Also:

replyTo(EmailAddress)

replyTo

public T replyTo(java.lang.String... replyTos)

Appends one or more REPLY-TO address.

Parameters:

replyTos - array of EmailAddresses to set.

Returns:

this

See Also:

replyTo(EmailAddress...)

replyTo

public T replyTo(jakarta.mail.Address... replyTos)

Appeds one or more REPLY-TO address.

Parameters:

replyTos - array of Addresses to set.

Returns:

this

See Also:

replyTo(EmailAddress...)

replyTo

public T replyTo(EmailAddress... replyTo)

Appends REPLY-TO addresses.

Parameters:

replyTo - vararg of EmailAddresses to set.

Returns:

this

replyTo

public EmailAddress[] replyTo()

Returns REPLY-TO addresses.

resetReplyTo

public T resetReplyTo()

Resets all REPLY-To addresses.

cc

public T cc(EmailAddress to)

Appends CC address.

Parameters:

to - EmailAddress to add.

Returns:

this

cc

public T cc(java.lang.String cc)

Appends CC address.

Parameters:

cc - Address may be specified with personal name like this: Jenny Doe <email@foo.com>.

Returns:

this

See Also:

cc(EmailAddress)

cc

public T cc(java.lang.String personalName,
            java.lang.String cc)

Appends CC address.

Parameters:

personalName - personal name.

cc - email address.

Returns:

this

See Also:

cc(EmailAddress)

cc

public T cc(jakarta.mail.Address cc)

Appends CC address.

Parameters:

cc - Address to add.

Returns:

this

See Also:

cc(EmailAddress)

cc

public T cc(java.lang.String... ccs)

Sets one or more CC address.

Parameters:

ccs - array of Strings to set.

Returns:

this

See Also:

cc(EmailAddress...)

cc

public T cc(jakarta.mail.Address... ccs)

Sets one or more CC address.

Parameters:

ccs - array of Addresss to set.

Returns:

this

See Also:

cc(EmailAddress...)

cc

public T cc(EmailAddress... ccs)

Appends CC addresses.

Parameters:

ccs - vararg of EmailAddresses to set.

Returns:

this

cc

public EmailAddress[] cc()

Returns CC addresses.

resetCc

public T resetCc()

Resets all CC addresses.

subject

public T subject(java.lang.String subject)

Sets message subject.

Parameters:

subject - The message subject to set.

Returns:

this

subject

public T subject(java.lang.String subject,
                 java.lang.String encoding)

Sets message subject with specified encoding to override default platform encoding. If the subject contains non US-ASCII characters, it will be encoded using the specified charset. If the subject contains only US-ASCII characters, no encoding is done and it is used as-is. The application must ensure that the subject does not contain any line breaks.

Parameters:

subject - The message subject

encoding - The encoding for the message subject.

Returns:

this

subject

public java.lang.String subject()

Returns message subject.

Returns:

message subject.

subjectEncoding

public java.lang.String subjectEncoding()

Returns the message subject encoding.

Returns:

the message subject encoding.

messages

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

Returns all messages.

message

public T message(java.util.List<EmailMessage> msgsToAdd)

Adds multiple messages.

Parameters:

msgsToAdd - List of EmailMessages to add.

Returns:

this

message

public T message(EmailMessage msgToAdd)

Adds an EmailMessage.

Parameters:

msgToAdd - EmailMessage to add.

Returns:

this

message

public T message(java.lang.String text,
                 java.lang.String mimeType,
                 java.lang.String encoding)

Adds a EmailMessage.

Parameters:

text - The text to add as a String.

mimeType - The MIME type as a String.

encoding - The encoding as a String.

Returns:

this

See Also:

message(EmailMessage)

message

public T message(java.lang.String text,
                 java.lang.String mimeType)

Adds a EmailMessage.

Parameters:

text - The text to add as a String.

mimeType - The MIME type as a String.

Returns:

this

See Also:

message(EmailMessage)

textMessage

public T textMessage(java.lang.String text)

Adds plain message text.

Parameters:

text - The text to add as a String.

Returns:

this

See Also:

message(String, String)

textMessage

public T textMessage(java.lang.String text,
                     java.lang.String encoding)

Adds plain message text.

Parameters:

text - The text to add as a String.

encoding - The encoding as a String.

Returns:

this

See Also:

message(EmailMessage)

htmlMessage

public T htmlMessage(java.lang.String html)

Adds HTML message.

Parameters:

html - The HTML to add as a String.

Returns:

this

See Also:

message(EmailMessage)

htmlMessage

public T htmlMessage(java.lang.String html,
                     java.lang.String encoding)

Adds HTML message.

Parameters:

html - The HTML to add as a String.

encoding - The encoding as a String.

Returns:

this

See Also:

message(EmailMessage)

headers

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

Returns all headers as a HashMap.

Returns:

all headers in a HashMap

header

public T header(java.lang.String name,
                java.lang.String value)

Sets header value.

Parameters:

name - The name of the header.

value - The value of the header.

Returns:

this

headers

public T headers(java.util.Map<java.lang.String,java.lang.String> headersToSet)

Sets headers.

Parameters:

headersToSet - Headers to set.

Returns:

this

headers

public T headers(java.util.Enumeration<jakarta.mail.Header> headersToSet)

Sets headers.

Parameters:

headersToSet - Headers to set.

Returns:

this

See Also:

header(String, String)

header

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

Returns the value of a header.

Parameters:

name - The name of the header.

Returns:

The value of the header.

priority

public T priority(int priority)

Sets email priority.

Parameters:

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

priority

public int priority()

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

See Also:

priority(int)

attachments

public java.util.List<EmailAttachment<? extends jakarta.activation.DataSource>> attachments()

Returns the list of all EmailAttachments.

Returns:

List of EmailAttachments. Returns empty list if no attachment is available.

storeAttachments

protected T storeAttachments(java.util.List<EmailAttachment<? extends jakarta.activation.DataSource>> attachments)

Adds EmailAttachments.

Parameters:

attachments - List of EmailAttachments to add.

Returns:

this

storeAttachment

protected T storeAttachment(EmailAttachment<? extends jakarta.activation.DataSource> attachment)

Adds EmailAttachment.

Parameters:

attachment - EmailAttachment to add.

Returns:

this

attachments

public T attachments(java.util.List<EmailAttachment<? extends jakarta.activation.DataSource>> attachments)

Adds EmailAttachments.

Parameters:

attachments - List of EmailAttachments to add.

Returns:

this

attachment

public T attachment(EmailAttachment<? extends jakarta.activation.DataSource> attachment)

Adds EmailAttachment. Content ID will be set to null.

Parameters:

attachment - EmailAttachment to add.

Returns:

this

attachment

public T attachment(EmailAttachmentBuilder builder)

See Also:

attachment(EmailAttachment)

embeddedAttachment

public T embeddedAttachment(EmailAttachmentBuilder builder)

Attaches the embedded attachment: Content ID will be set if missing from attachment's file name.

Parameters:

builder - EmailAttachmentBuilder

Returns:

this

See Also:

embeddedAttachment(EmailAttachment)

embeddedAttachment

public T embeddedAttachment(EmailAttachment<? extends jakarta.activation.DataSource> attachment)

Embed EmailAttachment to last message. No header is changed.

Parameters:

attachment - EmailAttachment

Returns:

this

See Also:

storeAttachment(EmailAttachment)

sentDate

public T sentDate(java.util.Date date)

Sets email's sent date.

Parameters:

date - - Email's sent date. If null, then date will be set during the process of sending.

Returns:

this

sentDate

public java.util.Date sentDate()

Returns email's 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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

valueOrEmptyArray

protected EmailAddress[] valueOrEmptyArray(EmailAddress[] arr)