io.mangoo.email

Class Mail

java.lang.Object

io.mangoo.email.Mail

public class Mail
extends Object

Author:

svenkubiak

Constructor Summary

Constructors

Constructor and Description
Mail()

Method Summary

Modifier and Type	Method and Description
String	getTemplate()
Mail	isHtml() Mark the mail as an HTML mail
static Mail	newHtmlMail()
static Mail	newMail()
void	send() Sends the mail
Mail	withAttachment(File file) Adds a file attachment to the mail
Mail	withBCC(String recipient) Adds a bcc recipient to the mail
Mail	withBody(String body) Adds a custom to the mail This will overwrite rendering of the template!
Mail	withCC(String recipient) Adds a cc recipient to the mail
Mail	withContent(String key, Object value) Adds content to the template which will be rendered
Mail	withFrom(String from) Adds the from address to the mail
Mail	withRecipient(String recipient) Adds a recipient to the mail
Mail	withSubject(String subject) Adds a subject to the mail
Mail	withTemplate(String template) Add a template to the mail which will be rendered before the mail is send

Methods inherited from class java.lang.Object

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

Constructor Detail

Mail

public Mail()

Method Detail

newMail

public static Mail newMail()

newHtmlMail

public static Mail newHtmlMail()

withRecipient

public Mail withRecipient(String recipient)

Adds a recipient to the mail

Parameters:

recipient - The mail address of the recipient

Returns:

A mail object instance

withCC

public Mail withCC(String recipient)

Adds a cc recipient to the mail

Parameters:

recipient - The mail address of the cc recipient

Returns:

A mail object instance

withSubject

public Mail withSubject(String subject)

Adds a subject to the mail

Parameters:

subject - The subject of the email

Returns:

A mail object instance

withTemplate

public Mail withTemplate(String template)

Add a template to the mail which will be rendered before the mail is send

Parameters:

template - The path to the template fail (e.g. emails/mail.ftl)

Returns:

A mail object instance

getTemplate

public String getTemplate()

Returns:

The current template path

withBCC

public Mail withBCC(String recipient)

Adds a bcc recipient to the mail

Parameters:

recipient - The subject of the email

Returns:

A mail object instance

withBody

public Mail withBody(String body)

Adds a custom to the mail This will overwrite rendering of the template!

Parameters:

body - The body of the email

Returns:

A mail object instance

withFrom

public Mail withFrom(String from)

Adds the from address to the mail

Parameters:

from - The from address, e.g. jon.snow@winterfell.com

Returns:

A mail object instance

withAttachment

public Mail withAttachment(File file)

Adds a file attachment to the mail

Parameters:

file - The file to add

Returns:

A mail object instance

isHtml

public Mail isHtml()

Mark the mail as an HTML mail

Returns:

A mail object instance

withContent

public Mail withContent(String key,
                        Object value)

Adds content to the template which will be rendered

Parameters:

key - The key

value - The value

Returns:

A mail object instance

send

public void send()
          throws MangooMailerException

Sends the mail

Throws:

MangooMailerException - when sending the mail failed