be.ceau.simplemail

Class Mailer

java.lang.Object

be.ceau.simplemail.Mailer

public class Mailer
extends Object

Mailer service that handles the sending of one-off messages.
Instances of this class are immutable and threadsafe.
To create new instances of this class, a public constructor is available, as well as a fluent builder that provides some optional extras.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Mailer.Builder

Constructor Summary

Constructors

Constructor and Description
Mailer(String smtp) Construct a new Mailer instance to send mail over the given SMTP host.

Method Summary

Modifier and Type	Method and Description
static Mailer.Builder	builder(String smtp)
boolean	send(Mail mail) Verifies and sends given Mail argument. Verification checks whether sufficient information is availabe for sending the given Mail instance. In accordance with RFC 2822, the only required email headers are origination date (section 3.6.1) and from (section 3.6.2).

Methods inherited from class java.lang.Object

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

Constructor Detail

Mailer

public Mailer(String smtp)

Construct a new Mailer instance to send mail over the given SMTP host.

Parameters:

smtp - a valid SMTP host

Throws:

IllegalArgumentException - if smtp is blank

Method Detail

builder

public static Mailer.Builder builder(String smtp)

Parameters:

smtp - a valid SMTP host

Returns:

a new Builder object to construct a Mailer instance

send

public boolean send(Mail mail)

Verifies and sends given Mail argument.
Verification checks whether sufficient information is availabe for sending the given Mail instance.
In accordance with RFC 2822, the only required email headers are origination date (section 3.6.1) and from (section 3.6.2). This library deviates from this only in that it also requires at least one to address. All other fields are optional.
The from address is that which is set in the Mailer instance at construction, unless a value is also specified in the given Mail argument. In that case, the value from the Mail instance is used.

Parameters:

mail - the Mail instance to send

Returns:

true if the Mail instance was sent

Throws:

IllegalArgumentException - if the Mail argument is null or invalid

IllegalStateException - if neither this Mailer nor the Mail argument have a 'from' email address set