Package play.libs

Class Mail

java.lang.Object

play.libs.Mail

public class Mail
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Mail.SMTPAuthenticator

Field Summary

Fields

Modifier and Type	Field	Description
protected static AbstractMailSystemFactory	mailSystemFactory
static LegacyMockMailSystem	Mock	Just kept for compatibility reasons, use test double substitution mechanism instead.

Constructor Summary

Constructors

Constructor	Description
Mail()

Method Summary

Modifier and Type	Method	Description
static org.apache.commons.mail.Email	buildMessage(org.apache.commons.mail.Email email)
protected static MailSystem	currentMailSystem()
static javax.mail.Session	getSession()
static boolean	send(org.apache.commons.mail.Email email)	Send an email
static boolean	sendMessage(org.apache.commons.mail.Email msg)	Send a JavaMail message
static void	useMailSystem(MailSystem mailSystem)	Through this method you can substitute the current MailSystem.

Methods inherited from class java.lang.Object

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

Field Details

mailSystemFactory

protected static AbstractMailSystemFactory mailSystemFactory

Mock

public static LegacyMockMailSystem Mock

Just kept for compatibility reasons, use test double substitution mechanism instead.

See Also:

• useMailSystem(MailSystem)

Constructor Details

Mail

public Mail()

Method Details

send

public static boolean send(org.apache.commons.mail.Email email)

Send an email

Parameters:

email - An Email message

Returns:

true if email successfully send

currentMailSystem

protected static MailSystem currentMailSystem()

useMailSystem

public static void useMailSystem(MailSystem mailSystem)

Through this method you can substitute the current MailSystem. This is especially helpful for testing purposes like using mock libraries.

Author: Andreas Simon <[email protected]>

Parameters:

mailSystem - The mailSystem to use

See Also:

• MailSystem

buildMessage

public static org.apache.commons.mail.Email buildMessage(org.apache.commons.mail.Email email)
                                                  throws org.apache.commons.mail.EmailException

Throws:

org.apache.commons.mail.EmailException

getSession

public static javax.mail.Session getSession()

sendMessage

public static boolean sendMessage(org.apache.commons.mail.Email msg)

Send a JavaMail message

Parameters:

msg - An Email message

Returns:

true if email successfully send