Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

play.libs
Class Mail

java.lang.Object
  extended by play.libs.Mail

public class Mail
extends Object

Mail utils

Nested Class Summary
static class Mail.Mock
           
static class Mail.SMTPAuthenticator
           
 
Field Summary
static boolean asynchronousSend
           
static javax.mail.Session session
           
 
Constructor Summary
Mail()
           
 
Method Summary
protected static javax.mail.internet.MimeMessage addHeaders(javax.mail.internet.MimeMessage msg, Map<String,String> headers)
           
static javax.mail.internet.MimeMessage buildMessage(Object from, Object replyTo, Object[] recipients, String subject, String body, String alternate, String contentType, Object... attachments)
          Original method from the 1.0 release.
static javax.mail.internet.MimeMessage buildMimeMessage(javax.mail.internet.InternetAddress from, javax.mail.internet.InternetAddress replyTo, javax.mail.internet.InternetAddress[] recipients, String subject, String body, String alternate, String contentType, Object... attachments)
          Construct a MimeMessage
static javax.mail.internet.MimeMessage buildMimeMessage(javax.mail.internet.InternetAddress from, javax.mail.internet.InternetAddress replyTo, javax.mail.internet.InternetAddress[] recipients, String subject, String body, String alternate, String contentType, String charset, Map<String,String> headers, Object... attachments)
          Construct a MimeMessage
static javax.mail.internet.MimeMessage buildMimeMessage(String from, String replyTo, String[] recipients, String subject, String body, String alternate, String contentType, Object... attachments)
           
protected static javax.mail.Multipart getMultipart(String body, String alternate, String contentType, String charset)
           
static Future<Boolean> send(Object from, Object replyTo, Object[] recipients, String subject, String body, String alternate, String contentType, Object... attachments)
           
static Future<Boolean> send(String from, String[] recipients, String subject, String body)
          Send an email in text/plain format
static Future<Boolean> send(String from, String[] recipients, String subject, String body, javax.activation.DataSource... attachments)
          Send an email in text/plain
static Future<Boolean> send(String from, String[] recipients, String subject, String body, File... attachments)
          Send an email in text/plain
static Future<Boolean> send(String from, String replyTo, String[] recipients, String subject, String body, String alternate, String contentType, javax.activation.DataSource... attachments)
          Send an email
static Future<Boolean> send(String from, String replyTo, String[] recipients, String subject, String body, String alternate, String contentType, File... attachments)
          Send an email
static Future<Boolean> send(String from, String recipient, String subject, String body)
          Send an email in plain text
static Future<Boolean> send(String from, String recipient, String subject, String body, javax.activation.DataSource... attachments)
          Send an email in text/plain
static Future<Boolean> send(String from, String recipient, String subject, String body, File... attachments)
          Send an email in text/plain
static Future<Boolean> send(String from, String recipient, String subject, String body, String alternate)
          Send an email in text/html with a text/plain alternative
static Future<Boolean> send(String from, String recipient, String subject, String body, String alternate, javax.activation.DataSource... attachments)
          Send an email in text/html with a text/plain alternative and attachments
static Future<Boolean> send(String from, String recipient, String subject, String body, String alternate, File... attachments)
          Send an email in text/html with a text/plain alternative and attachments
static Future<Boolean> sendEmail(Object from, Object replyTo, Object[] recipients, Object[] ccs, Object[] bccs, String subject, String body, String alternate, String contentType, String charset, Map<String,String> headers, Object... attachments)
          Send an email
static Future<Boolean> sendEmail(Object from, Object replyTo, Object[] recipients, String subject, String body, String alternate, String contentType, String charset, Map<String,String> headers, Object... attachments)
          Send an email
static Future<Boolean> sendMessage(javax.mail.Message msg)
          Send a JavaMail message
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

session

public static javax.mail.Session session

asynchronousSend

public static boolean asynchronousSend
Constructor Detail

Mail

public Mail()
Method Detail

send

public static Future<Boolean> send(String from,
                                   String recipient,
                                   String subject,
                                   String body)
Send an email in plain text

Parameters:
from - From address. Can be of the form xxx
recipient - To address. Can be of the form xxx
subject - Subject
body - Body

send

public static Future<Boolean> send(String from,
                                   String recipient,
                                   String subject,
                                   String body,
                                   String alternate)
Send an email in text/html with a text/plain alternative

Parameters:
from - From address. Can be of the form xxx
recipient - To address. Can be of the form xxx
subject - Subject
body - text/html body content
alternate - text/plain alternative content (optional)

send

public static Future<Boolean> send(String from,
                                   String recipient,
                                   String subject,
                                   String body,
                                   String alternate,
                                   File... attachments)
Send an email in text/html with a text/plain alternative and attachments

Parameters:
from - From address. Can be of the form xxx
recipient - To address. Can be of the form xxx
subject - Subject
body - text/html body content
alternate - text/plain alternative content (optional)
attachments - File attachments

send

public static Future<Boolean> send(String from,
                                   String recipient,
                                   String subject,
                                   String body,
                                   String alternate,
                                   javax.activation.DataSource... attachments)
Send an email in text/html with a text/plain alternative and attachments

Parameters:
from - From address. Can be of the form xxx
recipient - To address. Can be of the form xxx
subject - Subject
body - text/html body content
alternate - text/plain alternative content (optional)
attachments - DataSource attachments

send

public static Future<Boolean> send(String from,
                                   String[] recipients,
                                   String subject,
                                   String body)
Send an email in text/plain format

Parameters:
from - From address. Can be of the form xxx
recipients - To addresses. Can be of the form xxx
subject - Subject
body - The text/plain body of the email

send

public static Future<Boolean> send(String from,
                                   String recipient,
                                   String subject,
                                   String body,
                                   File... attachments)
Send an email in text/plain

Parameters:
from - From address. Can be of the form xxx
recipient - To address. Can be of the form xxx
subject - Subject
body - plain/text body of the email
attachments - File attachments

send

public static Future<Boolean> send(String from,
                                   String recipient,
                                   String subject,
                                   String body,
                                   javax.activation.DataSource... attachments)
Send an email in text/plain

Parameters:
from - From address. Can be of the form xxx
recipient - To address. Can be of the form xxx
subject - Subject
body - plain/text body of the email
attachments - DataSource attachments

send

public static Future<Boolean> send(String from,
                                   String[] recipients,
                                   String subject,
                                   String body,
                                   File... attachments)
Send an email in text/plain

Parameters:
from - From address Can be of the form xxx
recipients - To addresses Can be of the form xxx
subject - Subject
body - Body
attachments - File attachments

send

public static Future<Boolean> send(String from,
                                   String[] recipients,
                                   String subject,
                                   String body,
                                   javax.activation.DataSource... attachments)
Send an email in text/plain

Parameters:
from - From address Can be of the form xxx
recipients - To addresses Can be of the form xxx
subject - Subject
body - Body
attachments - DataSource attachments

send

public static Future<Boolean> send(String from,
                                   String replyTo,
                                   String[] recipients,
                                   String subject,
                                   String body,
                                   String alternate,
                                   String contentType,
                                   File... attachments)
Send an email

Parameters:
from - From address. Can be of the form xxx
replyTo - ReplyTo address Can be of the form xxx
recipients - To addresses
subject - Subject
body - body of the email
alternate - text/plain body (optional). This parameter is ignored if contentType is set to text/plain or is null.
contentType - The content type of the body (text/plain or text/html)
attachments - File attachments

send

public static Future<Boolean> send(String from,
                                   String replyTo,
                                   String[] recipients,
                                   String subject,
                                   String body,
                                   String alternate,
                                   String contentType,
                                   javax.activation.DataSource... attachments)
Send an email

Parameters:
from - From address. Can be of the form xxx
replyTo - ReplyTo address Can be of the form xxx
recipients - To addresses
subject - Subject
body - body of the email
alternate - text/plain body (optional). This parameter is ignored if contentType is set to text/plain or is null.
contentType - The content type of the body (text/plain or text/html)
attachments - DataSource attachments

send

public static Future<Boolean> send(Object from,
                                   Object replyTo,
                                   Object[] recipients,
                                   String subject,
                                   String body,
                                   String alternate,
                                   String contentType,
                                   Object... attachments)
Parameters:
from - From address a String or an InternetAddress
replyTo - ReplyTo address a String or an InternetAddress
recipients - To addresses an Array of String or/and InternetAddress
subject - Subject
body - body of the email
alternate - text/plain body (optional). This parameter is ignored if contentType is set to text/plain or is null.
contentType - The content type of the body (text/plain or text/html)
attachments - File attachments

sendEmail

public static Future<Boolean> sendEmail(Object from,
                                        Object replyTo,
                                        Object[] recipients,
                                        String subject,
                                        String body,
                                        String alternate,
                                        String contentType,
                                        String charset,
                                        Map<String,String> headers,
                                        Object... attachments)
Send an email

Parameters:
from - From address a String or an InternetAddress
replyTo - ReplyTo address a String or an InternetAddress
recipients - To addresses an Array of String or/and InternetAddress
subject - Subject
body - body of the email
alternate - text/plain body (optional). This parameter is ignored if contentType is set to text/plain or is null.
contentType - The content type of the body (text/plain or text/html)
charset - The character set of the message (optional)
headers - The mail headers (optional)
attachments - File or DataSource attachments

sendEmail

public static Future<Boolean> sendEmail(Object from,
                                        Object replyTo,
                                        Object[] recipients,
                                        Object[] ccs,
                                        Object[] bccs,
                                        String subject,
                                        String body,
                                        String alternate,
                                        String contentType,
                                        String charset,
                                        Map<String,String> headers,
                                        Object... attachments)
Send an email

Parameters:
from - From address a String or an InternetAddress
replyTo - ReplyTo address a String or an InternetAddress
recipients - To addresses an Array of String or/and InternetAddress
subject - Subject
body - body of the email
alternate - text/plain body (optional). This parameter is ignored if contentType is set to text/plain or is null.
contentType - The content type of the body (text/plain or text/html)
charset - The character set of the message (optional)
headers - The mail headers (optional)
attachments - File or DataSource attachments

buildMessage

public static javax.mail.internet.MimeMessage buildMessage(Object from,
                                                           Object replyTo,
                                                           Object[] recipients,
                                                           String subject,
                                                           String body,
                                                           String alternate,
                                                           String contentType,
                                                           Object... attachments)
                                                    throws javax.mail.MessagingException
Original method from the 1.0 release.

Parameters:
from - From address a String or an InternetAddress
replyTo - ReplyTo address a String or an InternetAddress
recipients - To addresses an Array of String or/and InternetAddress
subject -
body -
alternate -
contentType -
attachments -
Returns:
Throws:
javax.mail.MessagingException

buildMimeMessage

public static javax.mail.internet.MimeMessage buildMimeMessage(String from,
                                                               String replyTo,
                                                               String[] recipients,
                                                               String subject,
                                                               String body,
                                                               String alternate,
                                                               String contentType,
                                                               Object... attachments)
                                                        throws javax.mail.MessagingException
Parameters:
from -
replyTo -
recipients -
subject -
body -
alternate -
contentType -
attachments -
Returns:
Throws:
javax.mail.MessagingException

buildMimeMessage

public static javax.mail.internet.MimeMessage buildMimeMessage(javax.mail.internet.InternetAddress from,
                                                               javax.mail.internet.InternetAddress replyTo,
                                                               javax.mail.internet.InternetAddress[] recipients,
                                                               String subject,
                                                               String body,
                                                               String alternate,
                                                               String contentType,
                                                               Object... attachments)
                                                        throws javax.mail.MessagingException
Construct a MimeMessage

Parameters:
from - From address
recipients - To addresses
subject - Subject
body - body of the email
alternate - text/plain body (optional). This parameter is ignored if contentType is set to text/plain or is null.
contentType - The content type of the body (text/plain or text/html) (optional)
attachments - File attachments
Throws:
javax.mail.MessagingException

buildMimeMessage

public static javax.mail.internet.MimeMessage buildMimeMessage(javax.mail.internet.InternetAddress from,
                                                               javax.mail.internet.InternetAddress replyTo,
                                                               javax.mail.internet.InternetAddress[] recipients,
                                                               String subject,
                                                               String body,
                                                               String alternate,
                                                               String contentType,
                                                               String charset,
                                                               Map<String,String> headers,
                                                               Object... attachments)
                                                        throws javax.mail.MessagingException
Construct a MimeMessage

Parameters:
from - From address
recipients - To addresses
subject - Subject
body - body of the email
alternate - text/plain body (optional). This parameter is ignored if contentType is set to text/plain or is null.
contentType - The content type of the body (text/plain or text/html) (optional)
charset - The character set of the message (optional)
headers - The mail headers (optional)
attachments - File or DataSource attachments
Throws:
javax.mail.MessagingException

addHeaders

protected static javax.mail.internet.MimeMessage addHeaders(javax.mail.internet.MimeMessage msg,
                                                            Map<String,String> headers)
                                                     throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException

getMultipart

protected static javax.mail.Multipart getMultipart(String body,
                                                   String alternate,
                                                   String contentType,
                                                   String charset)
                                            throws javax.mail.MessagingException
Throws:
javax.mail.MessagingException

sendMessage

public static Future<Boolean> sendMessage(javax.mail.Message msg)
Send a JavaMail message

Parameters:
msg - A JavaMail message
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Guillaume Bort & zenexity - Distributed under Apache 2 licence, without any warrantly