org.jahia.services.mail

Class MailServiceImpl

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.mail.MailService

org.jahia.services.mail.MailServiceImpl

All Implemented Interfaces:

EventListener, org.apache.camel.CamelContextAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

public class MailServiceImpl
extends MailService
implements org.apache.camel.CamelContextAware, org.springframework.beans.factory.InitializingBean, org.springframework.beans.factory.DisposableBean, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

This service define method to send e-mails.

Author:

MAP, Serge Huber

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MailServiceImpl.MailSettingsChangedEvent This event is fired when the changes in mail server connection settings are detected (notification from other cluster nodes).

Field Summary

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
MailServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
String	defaultRecipient()
String	defaultSender()
void	destroy()
org.apache.camel.CamelContext	getCamelContext()
String	getEndpointUri()
MailSettings	getSettings() Returns the settings.
void	handleSend(org.apache.camel.Exchange exchange)
protected void	load()
void	onApplicationEvent(org.springframework.context.ApplicationEvent evt)
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.
void	sendMessage(MailMessage message) Send provided mail message.
boolean	sendMessage(String message) Send message to the default Jahia settings defined in the jahia.properties file.
void	sendMessage(String endpointUri, MailMessage message) Sends the provided mail message to the specified endpoint.
boolean	sendMessage(String to, String message) Send message to the desired destination.
boolean	sendMessage(String from, String to, String message) Send message to the desired destination.
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.
void	sendMessage(String from, String toList, String ccList, String bcclist, String subject, String textBody, String htmlBody) Send message to the desired destination with cc and bcc option.
void	sendMessage(String endpointUri, String from, String toList, String ccList, String bcclist, String subject, String textBody, String htmlBody)
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.
void	sendMessageWithTemplate(String template, Map<String,Object> boundObjects, String toMail, String fromMail, String ccList, String bcclist, Locale locale, String templatePackageName)
void	setCamelContext(org.apache.camel.CamelContext camelContext)
void	setCharset(String charset)
void	setMailEndpointUri(String mailEndpointUri) Sets the URI of the default mail sending endpoint.
void	setScriptEngineUtils(ScriptEngineUtils scriptEngineUtils)
void	setTemplateCharset(String templateCharset)
void	setTemplateManagerService(JahiaTemplateManagerService templateManagerService)
void	start()
void	stop()
void	store(MailSettings cfg) Persists the changes in mail server connection configuration.
protected void	store(MailSettings cfg, JCRSessionWrapper session)
static MailSettingsValidationResult	validateSettings(MailSettings cfg, boolean skipIfEmpty) Validates entered values for mail settings.

Methods inherited from class org.jahia.services.mail.MailService

getInstance, isEnabled, isValidEmailAddress, sendMessage

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object

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

Constructor Detail

MailServiceImpl

public MailServiceImpl()

Method Detail

validateSettings

public static MailSettingsValidationResult validateSettings(MailSettings cfg,
                                                            boolean skipIfEmpty)

Validates entered values for mail settings.

Parameters:

cfg - the mail settings, entered by user

skipIfEmpty - skips the validation and returns successful result if all values are empty

Returns:

the validation result object

defaultRecipient

public String defaultRecipient()

Specified by:

defaultRecipient in class MailService

defaultSender

public String defaultSender()

Specified by:

defaultSender in class MailService

getCamelContext

public org.apache.camel.CamelContext getCamelContext()

Specified by:

getCamelContext in interface org.apache.camel.CamelContextAware

getSettings

public MailSettings getSettings()

Returns the settings.

Specified by:

getSettings in class MailService

Returns:

the settings

handleSend

@Handler
public void handleSend(org.apache.camel.Exchange exchange)

getEndpointUri

public String getEndpointUri()

sendHtmlMessage

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

Description copied from class: MailService

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

Specified by:

sendHtmlMessage in class MailService

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 boolean sendMessage(String message)

Description copied from class: MailService

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

Specified by:

sendMessage in class MailService

Parameters:

message - The message to send

Returns:

True if message is sent successfully, false otherwise

sendMessage

public boolean sendMessage(String to,
                           String message)

Description copied from class: MailService

Send message to the desired destination.

Specified by:

sendMessage in class MailService

Parameters:

to - The message destination.

message - The message to send.

Returns:

True if message is sent successfully, false otherwise

sendMessage

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

Description copied from class: MailService

Send message to the desired destination.

Specified by:

sendMessage in class MailService

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 boolean sendMessage(String from,
                           String to,
                           String cc,
                           String bcc,
                           String subject,
                           String message)

Description copied from class: MailService

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

Specified by:

sendMessage in class MailService

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 void sendMessage(String from,
                        String toList,
                        String ccList,
                        String bcclist,
                        String subject,
                        String textBody,
                        String htmlBody)

Description copied from class: MailService

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

Specified by:

sendMessage in class MailService

Parameters:

from - The message sender

toList - The message destination.

ccList - The message copy destination.

bcclist - The message copy blind destination.

subject - The message subject.

textBody - The text message to send

htmlBody - The HTML message to send

sendMessage

public void sendMessage(String endpointUri,
                        String from,
                        String toList,
                        String ccList,
                        String bcclist,
                        String subject,
                        String textBody,
                        String htmlBody)

sendMessage

public void sendMessage(MailMessage message)

Description copied from class: MailService

Send provided mail message.

Specified by:

sendMessage in class MailService

Parameters:

message - the mail message to be sent

sendMessage

public void sendMessage(String endpointUri,
                        MailMessage message)

Sends the provided mail message to the specified endpoint.

Parameters:

endpointUri - the target endpoint URL to send the message

message - the mail message to be sent

setCamelContext

public void setCamelContext(org.apache.camel.CamelContext camelContext)

Specified by:

setCamelContext in interface org.apache.camel.CamelContextAware

setMailEndpointUri

public void setMailEndpointUri(String mailEndpointUri)

Sets the URI of the default mail sending endpoint.

Parameters:

mailEndpointUri - the URI of the default mail sending endpoint

start

public void start()

Specified by:

start in class JahiaService

stop

public void stop()

Specified by:

stop in class JahiaService

sendMessageWithTemplate

public 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

Specified by:

sendMessageWithTemplate in class MailService

Throws:

javax.jcr.RepositoryException

ScriptException

sendMessageWithTemplate

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

Description copied from class: MailService

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

Specified by:

sendMessageWithTemplate in class MailService

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

destroy

public void destroy()
             throws Exception

Specified by:

destroy in interface org.springframework.beans.factory.DisposableBean

Throws:

Exception

setScriptEngineUtils

public void setScriptEngineUtils(ScriptEngineUtils scriptEngineUtils)

load

protected void load()

store

public void store(MailSettings cfg)

Description copied from class: MailService

Persists the changes in mail server connection configuration.

Specified by:

store in class MailService

Parameters:

cfg - the new mail settings to be stored

store

protected void store(MailSettings cfg,
                     JCRSessionWrapper session)
              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

onApplicationEvent

public void onApplicationEvent(org.springframework.context.ApplicationEvent evt)

Specified by:

onApplicationEvent in interface org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

setCharset

public void setCharset(String charset)

setTemplateManagerService

public void setTemplateManagerService(JahiaTemplateManagerService templateManagerService)

setTemplateCharset

public void setTemplateCharset(String templateCharset)