be.ceau.simplemail

Class Mail

java.lang.Object

be.ceau.simplemail.Mail

All Implemented Interfaces:

Serializable

public class Mail
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Mail() Constructs a new empty Mail instance

Method Summary

Modifier and Type	Method and Description
Mail	bcc(javax.mail.internet.InternetAddress bcc) Adds an email address as bcc recipient. Calling this method multiple times adds multiple bcc addresses to the email.
Mail	bcc(String bcc)
Mail	cc(javax.mail.internet.InternetAddress cc) Adds an email address as cc recipient. Calling this method multiple times adds multiple cc addresses to the email.
Mail	cc(String cc)
Mail	from(javax.mail.internet.InternetAddress from) Adds an email address as sender. Calling this method overwrites any value for the from field set previously.
Mail	from(String from)
Mail	to(javax.mail.internet.InternetAddress to) Adds an email address as to recipient. Calling this method multiple times adds multiple to addresses to the email.
Mail	to(String to)
String	toString()
Mail	withHtml(String html)
Mail	withSubject(String subject)
Mail	withText(String txt)

Methods inherited from class java.lang.Object

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

Constructor Detail

Mail

public Mail()

Constructs a new empty Mail instance

Method Detail

from

public Mail from(javax.mail.internet.InternetAddress from)

Adds an email address as sender.
Calling this method overwrites any value for the from field set previously.

Parameters:

from - a valid, non-null InternetAddress

Returns:

this Mail instance, to allow for method chaining

Throws:

IllegalArgumentException - if argument is null

from

public Mail from(String from)

Parameters:

from - a valid, non-blank String that can be parsed as InternetAddress

Returns:

this Mail instance, to allow for method chaining

Throws:

IllegalArgumentException - if argument is not a legal email address

See Also:

from(InternetAddress)

to

public Mail to(javax.mail.internet.InternetAddress to)

Adds an email address as to recipient.
Calling this method multiple times adds multiple to addresses to the email. It does not overwrite previously set addresses.

Parameters:

to - a valid, non-null InternetAddress

Returns:

this Mail instance, to allow for method chaining

Throws:

IllegalArgumentException - if argument is null

to

public Mail to(String to)

Parameters:

to - a valid, non-blank String that can be parsed as InternetAddress

Returns:

this Mail instance

Throws:

IllegalArgumentException - if argument is not a legal email address

See Also:

to(InternetAddress)

cc

public Mail cc(javax.mail.internet.InternetAddress cc)

Adds an email address as cc recipient.
Calling this method multiple times adds multiple cc addresses to the email. It does not overwrite previously set addresses.

Parameters:

cc - a valid, non-null InternetAddress

Returns:

this Mail instance, to allow for method chaining

Throws:

IllegalArgumentException - if argument is null

cc

public Mail cc(String cc)

Parameters:

cc - a valid, non-blank String that can be parsed as InternetAddress

Returns:

this Mail instance

Throws:

IllegalArgumentException - if argument is not a legal email address

See Also:

cc(InternetAddress)

bcc

public Mail bcc(javax.mail.internet.InternetAddress bcc)

Adds an email address as bcc recipient.
Calling this method multiple times adds multiple bcc addresses to the email. It does not overwrite previously set addresses.

Parameters:

bcc - a valid, non-null InternetAddress

Returns:

this Mail instance, to allow for method chaining

Throws:

IllegalArgumentException - if argument is null

bcc

public Mail bcc(String bcc)

Parameters:

bcc - a valid, non-blank String that can be parsed as InternetAddress

Returns:

this Mail instance

Throws:

IllegalArgumentException - if argument is not a legal email address

See Also:

bcc(InternetAddress)

withSubject

public Mail withSubject(String subject)

Parameters:

subject - a String (no restrictions)

Returns:

this Mail instance, to allow for method chaining

withText

public Mail withText(String txt)

Parameters:

txt - a String (no restrictions)

Returns:

this Mail instance, to allow for method chaining

withHtml

public Mail withHtml(String html)

Parameters:

html - a String (no restrictions)

Returns:

this Mail instance, to allow for method chaining

toString

public String toString()

Overrides:

toString in class Object