org.jahia.services.mail

Class MailService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.mail.MailService

Direct Known Subclasses:

MailServiceImpl

public abstract class MailService
extends JahiaService

Jahia mail service implementation.

Author:

Serge Huber Date: Jul 25, 2005 Time: 12:22:20 PM

Field Summary

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
MailService()

Method Summary

Modifier and Type	Method and Description
abstract String	defaultRecipient()
abstract String	defaultSender()
static MailService	getInstance() Returns an instance of the mail service.
abstract MailSettings	getSettings() Returns mail configuration settings.
boolean	isEnabled() Returns true if the mail service is enabled and settings are valid.
static boolean	isValidEmailAddress(String address, boolean allowMultiple) Checks, if the specified string is a valid e-mail address according to RFC822.
abstract boolean	sendHtmlMessage(String from, String to, String cc, String bcc, String subject, String message) Send message in the HTML format to the desired destination with cc and bcc option.
abstract void	sendMessage(MailMessage message) Send provided mail message.
void	sendMessage(org.springframework.mail.javamail.MimeMessagePreparator mimeMessagePreparator)
abstract boolean	sendMessage(String message) Send message to the default Jahia settings defined in the jahia.properties file.
abstract boolean	sendMessage(String to, String message) Send message to the desired destination.
abstract boolean	sendMessage(String from, String to, String message) Send message to the desired destination.
abstract boolean	sendMessage(String from, String to, String cc, String bcc, String subject, String message) Send message to the desired destination with cc and bcc option.
abstract void	sendMessage(String from, String to, String cc, String bcc, String subject, String textBody, String htmlBody) Send message to the desired destination with cc and bcc option.
abstract void	sendMessageWithTemplate(MailMessage message, String template, Map<String,Object> boundObjects, Locale locale, String templatePackageName) Send provided mail message using specified template that is responsible for producing mail subject and body.
abstract void	sendMessageWithTemplate(String template, Map<String,Object> boundObjects, String toMail, String fromMail, String ccList, String bcclist, Locale locale, String templatePackageName)
abstract void	store(MailSettings cfg) Persists the changes in mail server connection configuration.

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

MailService

public MailService()

Method Detail

getInstance

public static MailService getInstance()

Returns an instance of the mail service.

Returns:

an instance of the mail service

sendMessage

public abstract boolean sendMessage(String message)

Send message to the default Jahia settings defined in the jahia.properties file.

Parameters:

message - The message to send

Returns:

True if message is sent successfully, false otherwise

sendMessage

public abstract boolean sendMessage(String to,
                                    String message)

Send message to the desired destination.

Parameters:

to - The message destination.

message - The message to send.

Returns:

True if message is sent successfully, false otherwise

sendMessage

public abstract boolean sendMessage(String from,
                                    String to,
                                    String message)

Send message to the desired destination.

Parameters:

from - The message sender

to - The message destination.

message - The message to send.

Returns:

True if message is sent successfully, false otherwise

sendMessage

public abstract boolean sendMessage(String from,
                                    String to,
                                    String cc,
                                    String bcc,
                                    String subject,
                                    String message)

Send message to the desired destination with cc and bcc option. The subject can also be mentioned.

Parameters:

from - The message sender

to - The message destination.

cc - The message copy destination.

bcc - The message copy blind destination.

subject - The message subject.

message - The message to send.

Returns:

True if message is sent successfully, false otherwise

sendMessage

public abstract void sendMessage(String from,
                                 String to,
                                 String cc,
                                 String bcc,
                                 String subject,
                                 String textBody,
                                 String htmlBody)

Send message to the desired destination with cc and bcc option. The subject can also be mentioned.

Parameters:

from - The message sender

to - The message destination.

cc - The message copy destination.

bcc - The message copy blind destination.

subject - The message subject.

textBody - The text message to send

htmlBody - The HTML message to send

sendHtmlMessage

public abstract boolean sendHtmlMessage(String from,
                                        String to,
                                        String cc,
                                        String bcc,
                                        String subject,
                                        String message)

Send message in the HTML format to the desired destination with cc and bcc option. The subject can also be mentioned.

Parameters:

from - The message sender

to - The message destination.

cc - The message copy destination.

bcc - The message copy blind destination.

subject - The message subject.

message - The message to send.

Returns:

True if message is sent successfully, false otherwise

defaultRecipient

public abstract String defaultRecipient()

defaultSender

public abstract String defaultSender()

isEnabled

public boolean isEnabled()

Returns true if the mail service is enabled and settings are valid.

Returns:

true if the mail service is enabled and settings are valid

getSettings

public abstract MailSettings getSettings()

Returns mail configuration settings.

Returns:

mail configuration settings

isValidEmailAddress

public static boolean isValidEmailAddress(String address,
                                          boolean allowMultiple)

Checks, if the specified string is a valid e-mail address according to RFC822.

Parameters:

address - the address to be checked

allowMultiple - are multiple addresses allowed (separated by comma)

Returns:

true, if the specified string is a valid e-mail address according to RFC822

sendMessage

public void sendMessage(org.springframework.mail.javamail.MimeMessagePreparator mimeMessagePreparator)

sendMessageWithTemplate

public abstract void sendMessageWithTemplate(String template,
                                             Map<String,Object> boundObjects,
                                             String toMail,
                                             String fromMail,
                                             String ccList,
                                             String bcclist,
                                             Locale locale,
                                             String templatePackageName)
                                      throws javax.jcr.RepositoryException,
                                             ScriptException

Throws:

javax.jcr.RepositoryException

ScriptException

store

public abstract void store(MailSettings cfg)

Persists the changes in mail server connection configuration.

Parameters:

cfg - the new mail settings to be stored

sendMessage

public abstract void sendMessage(MailMessage message)

Send provided mail message.

Parameters:

message - the mail message to be sent

Since:

7.2.3.3 / 7.3.0.1

sendMessageWithTemplate

public abstract void sendMessageWithTemplate(MailMessage message,
                                             String template,
                                             Map<String,Object> boundObjects,
                                             Locale locale,
                                             String templatePackageName)
                                      throws ScriptException

Send provided mail message using specified template that is responsible for producing mail subject and body.

Parameters:

message - the mail message to be sent

template - the template script path

boundObjects - the objects for the script engine

locale - the locale to find the appropriate template script

templatePackageName - the module ID to lookup i18n resources from

Throws:

ScriptException - in case of an error executing template script

Since:

7.2.3.3 / 7.3.0.1