org.ametys.core.util.mail

Class SendMailHelper

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.core.util.mail.SendMailHelper

All Implemented Interfaces:

Disposable, LogEnabled

public final class SendMailHelper
extends AbstractLogEnabled
implements Disposable

Helper for sending mail

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SendMailHelper.CssRule
private static class	SendMailHelper.CssSpecificity
private static class	SendMailHelper.MailSender
private static class	SendMailHelper.MailSenderThreadFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	__CSS_SPECIFICITY_ATTR_PATTERN Attribute selectors pattern for CSS specificity processing
protected static Pattern	__CSS_SPECIFICITY_CLASS_PATTERN Class selectors pattern for CSS specificity processing
protected static Pattern	__CSS_SPECIFICITY_ELEMENT_PATTERN Element selectors pattern for CSS specificity processing
protected static Pattern	__CSS_SPECIFICITY_ID_PATTERN ID selectors pattern for CSS specificity processing
protected static Pattern	__CSS_SPECIFICITY_PSEUDO_CLASS_NOT_PATTERN Specific :not pseudo-class selectors pattern for CSS specificity processing
protected static Pattern	__CSS_SPECIFICITY_PSEUDO_CLASS_PATTERN Pseudo-class selectors pattern for CSS specificity processing
protected static Pattern	__CSS_SPECIFICITY_PSEUDO_CLASS_WITH_BRACKETS_PATTERN Pseudo-class (with bracket) selectors pattern for CSS specificity processing
protected static Pattern	__CSS_SPECIFICITY_PSEUDO_ELEMENT_PATTERN Pseudo-element selectors pattern for CSS specificity processing
protected static Pattern	__CSS_SPECIFICITY_UNIVERSAL_AND_SEPARATOR_PATTERN Universal and separator characters pattern for CSS specificity processing
private static ExecutorService	__SINGLE_THREAD_EXECUTOR
protected static Logger	_LOGGER Logger

Constructor Summary

Constructors

Modifier	Constructor and Description
private	SendMailHelper()

Method Summary

Modifier and Type	Method and Description
private static String	_removeComments(String styleRules)
private static String	concatenateProperties(String oldProp, String newProp)
void	dispose()
static String	inlineCSS(String html) This method inline css in <style> tags directly in the appropriates tags.
static void	sendMail(String subject, String htmlBody, String textBody, Collection<File> attachments, String recipient, String sender) Sends mail without authentication, with attachments.
static void	sendMail(String subject, String htmlBody, String textBody, Collection<File> attachments, String recipient, String sender, List<String> cc, List<String> bcc, boolean async) Sends mail without authentication, with attachments.
static void	sendMail(String subject, String htmlBody, String textBody, Collection<File> attachments, String recipient, String sender, List<String> cc, List<String> bcc, boolean deliveryReceipt, boolean readReceipt, boolean async) Sends mail without authentication, with attachments.
static void	sendMail(String subject, String htmlBody, String textBody, Collection<File> attachments, String recipient, String sender, List<String> cc, List<String> bcc, boolean deliveryReceipt, boolean readReceipt, String host, long port, String securityProtocol, boolean async) Sends mail without authentication, with attachments.
static void	sendMail(String subject, String htmlBody, String textBody, Collection<File> attachments, String recipient, String sender, List<String> cc, List<String> bcc, boolean deliveryReceipt, boolean readReceipt, String host, long port, String securityProtocol, String user, String password, boolean async) Sends mail with authentication and attachments.
static void	sendMail(String subject, String htmlBody, String textBody, String recipient, String sender) Sends mail without authentication or attachments.
static void	sendMail(String subject, String htmlBody, String textBody, String recipient, String sender, boolean async) Sends mail without authentication or attachments.
static void	sendMail(String subject, String htmlBody, String textBody, String recipient, String sender, String host, long port, String securityProtocol, boolean async) Sends mail without authentication or attachments.
static void	sendMail(String subject, String htmlBody, String textBody, String recipient, String sender, String host, long port, String securityProtocol, String user, String password, boolean async) Sends mail with authentication, without attachments.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

_LOGGER

protected static final Logger _LOGGER

Logger

__CSS_SPECIFICITY_ATTR_PATTERN

protected static final Pattern __CSS_SPECIFICITY_ATTR_PATTERN

Attribute selectors pattern for CSS specificity processing

__CSS_SPECIFICITY_ID_PATTERN

protected static final Pattern __CSS_SPECIFICITY_ID_PATTERN

ID selectors pattern for CSS specificity processing

__CSS_SPECIFICITY_CLASS_PATTERN

protected static final Pattern __CSS_SPECIFICITY_CLASS_PATTERN

Class selectors pattern for CSS specificity processing

__CSS_SPECIFICITY_PSEUDO_ELEMENT_PATTERN

protected static final Pattern __CSS_SPECIFICITY_PSEUDO_ELEMENT_PATTERN

Pseudo-element selectors pattern for CSS specificity processing

__CSS_SPECIFICITY_PSEUDO_CLASS_WITH_BRACKETS_PATTERN

protected static final Pattern __CSS_SPECIFICITY_PSEUDO_CLASS_WITH_BRACKETS_PATTERN

Pseudo-class (with bracket) selectors pattern for CSS specificity processing

__CSS_SPECIFICITY_PSEUDO_CLASS_PATTERN

protected static final Pattern __CSS_SPECIFICITY_PSEUDO_CLASS_PATTERN

Pseudo-class selectors pattern for CSS specificity processing

__CSS_SPECIFICITY_ELEMENT_PATTERN

protected static final Pattern __CSS_SPECIFICITY_ELEMENT_PATTERN

Element selectors pattern for CSS specificity processing

__CSS_SPECIFICITY_PSEUDO_CLASS_NOT_PATTERN

protected static final Pattern __CSS_SPECIFICITY_PSEUDO_CLASS_NOT_PATTERN

Specific :not pseudo-class selectors pattern for CSS specificity processing

__CSS_SPECIFICITY_UNIVERSAL_AND_SEPARATOR_PATTERN

protected static final Pattern __CSS_SPECIFICITY_UNIVERSAL_AND_SEPARATOR_PATTERN

Universal and separator characters pattern for CSS specificity processing

__SINGLE_THREAD_EXECUTOR

private static final ExecutorService __SINGLE_THREAD_EXECUTOR

Constructor Detail

SendMailHelper

private SendMailHelper()

Method Detail

sendMail

public static void sendMail(String subject,
                            String htmlBody,
                            String textBody,
                            String recipient,
                            String sender)
                     throws javax.mail.MessagingException

Sends mail without authentication or attachments.

Parameters:

subject - The mail subject

htmlBody - The HTML mail body. Can be null.

textBody - The text mail body. Can be null.

recipient - The recipient address

sender - The sender address

Throws:

javax.mail.MessagingException - If an error occurred while preparing or sending email

sendMail

public static void sendMail(String subject,
                            String htmlBody,
                            String textBody,
                            String recipient,
                            String sender,
                            boolean async)
                     throws javax.mail.MessagingException

Sends mail without authentication or attachments.

Parameters:

subject - The mail subject

htmlBody - The HTML mail body. Can be null.

textBody - The text mail body. Can be null.

recipient - The recipient address

sender - The sender address

async - True to use asynchronous mail sending

Throws:

javax.mail.MessagingException - If an error occurred while preparing or sending email

sendMail

public static void sendMail(String subject,
                            String htmlBody,
                            String textBody,
                            String recipient,
                            String sender,
                            String host,
                            long port,
                            String securityProtocol,
                            boolean async)
                     throws javax.mail.MessagingException

Sends mail without authentication or attachments.

Parameters:

subject - The mail subject

htmlBody - The HTML mail body. Can be null.

textBody - The text mail body. Can be null.

recipient - The recipient address

sender - The sender address

host - The server mail host

port - The server mail port

securityProtocol - The server mail security protocol

async - True to use asynchronous mail sending

Throws:

javax.mail.MessagingException - If an error occurred while preparing or sending email

sendMail

public static void sendMail(String subject,
                            String htmlBody,
                            String textBody,
                            String recipient,
                            String sender,
                            String host,
                            long port,
                            String securityProtocol,
                            String user,
                            String password,
                            boolean async)
                     throws javax.mail.MessagingException

Sends mail with authentication, without attachments.

Parameters:

subject - The mail subject

htmlBody - The HTML mail body. Can be null.

textBody - The text mail body. Can be null.

recipient - The recipient address

sender - The sender address

host - The server mail host

port - The server port

securityProtocol - The server mail security protocol

user - The user name

password - The user password

async - True to use asynchronous mail sending

Throws:

javax.mail.MessagingException - If an error occurred while preparing or sending email

sendMail

public static void sendMail(String subject,
                            String htmlBody,
                            String textBody,
                            Collection<File> attachments,
                            String recipient,
                            String sender)
                     throws javax.mail.MessagingException,
                            IOException

Sends mail without authentication, with attachments.

Parameters:

subject - The mail subject

htmlBody - The HTML mail body. Can be null.

textBody - The text mail body. Can be null.

attachments - the file attachments. Can be null.

recipient - The recipient address

sender - The sender address

Throws:

javax.mail.MessagingException - If an error occurred while preparing or sending email

IOException - if an error occurs while attaching a file.

sendMail

public static void sendMail(String subject,
                            String htmlBody,
                            String textBody,
                            Collection<File> attachments,
                            String recipient,
                            String sender,
                            List<String> cc,
                            List<String> bcc,
                            boolean async)
                     throws javax.mail.MessagingException,
                            IOException

Sends mail without authentication, with attachments.

Parameters:

subject - The mail subject

htmlBody - The HTML mail body. Can be null.

textBody - The text mail body. Can be null.

attachments - the file attachments. Can be null.

recipient - The recipient address

sender - The sender address

cc - Carbon copy address list. Can be null.

bcc - Blind carbon copy address list. Can be null.

async - True to use asynchronous mail sending

Throws:

javax.mail.MessagingException - If an error occurred while preparing or sending email

IOException - if an error occurs while attaching a file.

sendMail

public static void sendMail(String subject,
                            String htmlBody,
                            String textBody,
                            Collection<File> attachments,
                            String recipient,
                            String sender,
                            List<String> cc,
                            List<String> bcc,
                            boolean deliveryReceipt,
                            boolean readReceipt,
                            boolean async)
                     throws javax.mail.MessagingException,
                            IOException

Sends mail without authentication, with attachments.

Parameters:

subject - The mail subject

htmlBody - The HTML mail body. Can be null.

textBody - The text mail body. Can be null.

attachments - the file attachments. Can be null.

recipient - The recipient address

sender - The sender address

cc - Carbon copy address list. Can be null.

bcc - Blind carbon copy address list. Can be null.

deliveryReceipt - true to request that the receiving mail server send a notification when the mail is received.

readReceipt - true to request that the receiving mail client send a notification when the person opens the mail.

async - True to use asynchronous mail sending

Throws:

javax.mail.MessagingException - If an error occurred while preparing or sending email

IOException - if an error occurs while attaching a file.

sendMail

public static void sendMail(String subject,
                            String htmlBody,
                            String textBody,
                            Collection<File> attachments,
                            String recipient,
                            String sender,
                            List<String> cc,
                            List<String> bcc,
                            boolean deliveryReceipt,
                            boolean readReceipt,
                            String host,
                            long port,
                            String securityProtocol,
                            boolean async)
                     throws javax.mail.MessagingException,
                            IOException

Sends mail without authentication, with attachments.

Parameters:

subject - The mail subject

htmlBody - The HTML mail body. Can be null.

textBody - The text mail body. Can be null.

attachments - the file attachments. Can be null.

recipient - The recipient address

sender - The sender address

cc - Carbon copy address list. Can be null.

bcc - Blind carbon copy address list. Can be null.

deliveryReceipt - true to request that the receiving mail server send a notification when the mail is received.

readReceipt - true to request that the receiving mail client send a notification when the person opens the mail.

host - The server mail host

port - The server port

securityProtocol - The server mail security protocol

async - True to use asynchronous mail sending

Throws:

javax.mail.MessagingException - If an error occurred while preparing or sending email

IOException - if an error occurs while attaching a file.

sendMail

public static void sendMail(String subject,
                            String htmlBody,
                            String textBody,
                            Collection<File> attachments,
                            String recipient,
                            String sender,
                            List<String> cc,
                            List<String> bcc,
                            boolean deliveryReceipt,
                            boolean readReceipt,
                            String host,
                            long port,
                            String securityProtocol,
                            String user,
                            String password,
                            boolean async)
                     throws javax.mail.MessagingException,
                            IOException

Sends mail with authentication and attachments.

Parameters:

subject - The mail subject

htmlBody - The HTML mail body. Can be null.

textBody - The text mail body. Can be null.

attachments - the file attachments. Can be null.

recipient - The recipient address

sender - The sender address. Can be null when called by MailChecker.

cc - Carbon copy address list. Can be null.

bcc - Blind carbon copy address list. Can be null.

deliveryReceipt - true to request that the receiving mail server send a notification when the mail is received.

readReceipt - true to request that the receiving mail client send a notification when the person opens the mail.

host - The server mail host. Can be null when called by MailChecker.

securityProtocol - the security protocol to use when transporting the email

port - The server port

user - The user name

password - The user password

async - True to use asynchronous mail sending

Throws:

javax.mail.MessagingException - If an error occurred while preparing or sending email

IOException - if an error occurs while attaching a file.

inlineCSS

public static String inlineCSS(String html)

This method inline css in <style> tags directly in the appropriates tags. e.g. : <style>h1 {color: red;}</style> <h1>a</h1> becomes <h1 style="color: red">a</h1>

Parameters:

html - The initial non null html

Returns:

The inlined html

_removeComments

private static String _removeComments(String styleRules)

concatenateProperties

private static String concatenateProperties(String oldProp,
                                            String newProp)

dispose

public void dispose()

Specified by:

dispose in interface Disposable