be.ceau.simplemail

Class Mailer.Builder

java.lang.Object

be.ceau.simplemail.Mailer.Builder

Enclosing class:

Mailer

public static class Mailer.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
Mailer.Builder	bcc(javax.mail.internet.InternetAddress bcc) Adds an email address to the list of bcc addresses that will be added to every email sent by the resulting Mailer instance.
Mailer.Builder	bcc(String bcc)
Mailer	build()
Mailer.Builder	cc(javax.mail.internet.InternetAddress cc) Adds an email address to the list of cc addresses that will be added to every email sent by the resulting Mailer instance.
Mailer.Builder	cc(String cc)
Mailer.Builder	from(javax.mail.internet.InternetAddress from) Sets an email address that will be used as the from address for any Mail instance that does not specify such an address.
Mailer.Builder	from(String from)
Mailer.Builder	to(javax.mail.internet.InternetAddress to) Adds an email address to the list of to addresses that will be added to every email sent by the resulting Mailer instance.
Mailer.Builder	to(String to)

Methods inherited from class java.lang.Object

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

Method Detail

from

public Mailer.Builder from(javax.mail.internet.InternetAddress from)

Sets an email address that will be used as the from address for any Mail instance that does not specify such an address. If both the Mailer instance and a Mail message have a from address set, the from set in the Mail instance is used and a message is logged at the info level.

Parameters:

from - a valid, non-null InternetAddress

Returns:

this Mailer.Builder instance, to allow for method chaining

Throws:

IllegalArgumentException - if argument is null

from

public Mailer.Builder from(String from)

Parameters:

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

Returns:

this Mailer.Builder instance

Throws:

IllegalArgumentException - if argument is not a legal email address

See Also:

from(InternetAddress)

to

public Mailer.Builder to(javax.mail.internet.InternetAddress to)

Adds an email address to the list of to addresses that will be added to every email sent by the resulting Mailer instance.

Parameters:

to - a valid, non-null InternetAddress

Returns:

this Mailer.Builder instance, to allow for method chaining

Throws:

IllegalArgumentException - if argument is null

to

public Mailer.Builder to(String to)

Parameters:

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

Returns:

this Mailer.Builder instance

Throws:

IllegalArgumentException - if argument is a wrongly formatted address

See Also:

to(InternetAddress)

cc

public Mailer.Builder cc(javax.mail.internet.InternetAddress cc)

Adds an email address to the list of cc addresses that will be added to every email sent by the resulting Mailer instance.

Parameters:

cc - a valid, non-null InternetAddress

Returns:

this Mailer.Builder instance, to allow for method chaining

Throws:

IllegalArgumentException - if argument is null

cc

public Mailer.Builder cc(String cc)

Parameters:

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

Returns:

this Mailer.Builder instance

Throws:

IllegalArgumentException - if argument is a wrongly formatted address

See Also:

cc(InternetAddress)

bcc

public Mailer.Builder bcc(javax.mail.internet.InternetAddress bcc)

Adds an email address to the list of bcc addresses that will be added to every email sent by the resulting Mailer instance.

Parameters:

bcc - a valid, non-null InternetAddress

Returns:

this Mailer.Builder instance, to allow for method chaining

Throws:

IllegalArgumentException - if argument is null

bcc

public Mailer.Builder bcc(String bcc)

Parameters:

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

Returns:

this Mailer.Builder instance

Throws:

IllegalArgumentException - if argument is a wrongly formatted address

See Also:

bcc(InternetAddress)

build

public Mailer build()