Package org.nuxeo.ecm.platform.mail.service

Class MailServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.mail.service.MailServiceImpl

All Implemented Interfaces:

MailService, Adaptable, Component, Extensible, TimestampedService

public class MailServiceImpl
extends DefaultComponent
implements MailService

Author:

Alexandre Russel

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,jakarta.mail.Session>	sessions

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
MailServiceImpl()

Method Summary

Modifier and Type	Method	Description
jakarta.mail.Store	getConnectedStore(String name)	Returns a connected store for this factory.
jakarta.mail.Store	getConnectedStore(String name, Map<String,Object> context)
jakarta.mail.Transport	getConnectedTransport(String name)	Returns a connected transport for this factory.
jakarta.mail.Transport	getConnectedTransport(String name, Map<String,Object> context)
PropertiesFetcher	getFetcher(String name)
MailBoxActions	getMailBoxActions(String factoryName, String folderName)	Returns an actions pipe configured with this factory.
MailBoxActions	getMailBoxActions(String factoryName, String folderName, Map<String,Object> context)
MessageActionPipe	getPipe(String name)	Gets the pipe of actions for given name
jakarta.mail.Session	getSession(String name)	Returns a session for this factory, using the context to find the session or the default if no context is provided.
jakarta.mail.Session	getSession(String name, Map<String,Object> context)
protected jakarta.mail.Session	newSession(Properties props)
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	sendMail(String text, String subject, String factory, jakarta.mail.Address[] recipients)	Sends a mail using the setting of this factory to this recipients.
void	sendMail(String text, String subject, String factory, jakarta.mail.Address[] recipients, Map<String,Object> context)
void	stop(ComponentContext context)	Stop the component.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, addRuntimeMessage, addRuntimeMessage, deactivate, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerExtension, setLastModified, setModifiedNow, setName, start, unregister, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Details

sessions

protected final Map<String,jakarta.mail.Session> sessions

Constructor Details

MailServiceImpl

public MailServiceImpl()

Method Details

stop

public void stop(ComponentContext context)

Description copied from interface: Component

Stop the component.

Specified by:

stop in interface Component

Overrides:

stop in class DefaultComponent

registerContribution

public void registerContribution(Object contribution,
 String extensionPoint,
 ComponentInstance contributor)

Overrides:

registerContribution in class DefaultComponent

unregisterContribution

public void unregisterContribution(Object contribution,
 String extensionPoint,
 ComponentInstance contributor)

Overrides:

unregisterContribution in class DefaultComponent

getConnectedStore

public jakarta.mail.Store getConnectedStore(String name)
                                     throws jakarta.mail.MessagingException

Description copied from interface: MailService

Returns a connected store for this factory. The store needs to be closed after use.

Specified by:

getConnectedStore in interface MailService

Parameters:

name - The name of the factory that provides the properties.

Returns:

the store.

Throws:

jakarta.mail.MessagingException

getConnectedStore

public jakarta.mail.Store getConnectedStore(String name,
 Map<String,Object> context)
                                     throws jakarta.mail.MessagingException

Specified by:

getConnectedStore in interface MailService

Throws:

jakarta.mail.MessagingException

getConnectedTransport

public jakarta.mail.Transport getConnectedTransport(String name)
                                             throws jakarta.mail.MessagingException

Description copied from interface: MailService

Returns a connected transport for this factory. The transport needs to be closed after use.

Specified by:

getConnectedTransport in interface MailService

Parameters:

name - the name of the factory that provides the properties.

Returns:

the transport.

Throws:

jakarta.mail.MessagingException

getConnectedTransport

public jakarta.mail.Transport getConnectedTransport(String name,
 Map<String,Object> context)
                                             throws jakarta.mail.MessagingException

Specified by:

getConnectedTransport in interface MailService

Throws:

jakarta.mail.MessagingException

getSession

public jakarta.mail.Session getSession(String name)

Description copied from interface: MailService

Returns a session for this factory, using the context to find the session or the default if no context is provided.

Specified by:

getSession in interface MailService

getSession

public jakarta.mail.Session getSession(String name,
 Map<String,Object> context)

Specified by:

getSession in interface MailService

getMailBoxActions

public MailBoxActions getMailBoxActions(String factoryName,
 String folderName)
                                 throws jakarta.mail.MessagingException

Description copied from interface: MailService

Returns an actions pipe configured with this factory.

The actions will start from this folder. The context is be passed to the sessionFactory to be able to find the session. Use the default session if context is not used.

Specified by:

getMailBoxActions in interface MailService

Throws:

jakarta.mail.MessagingException

getMailBoxActions

public MailBoxActions getMailBoxActions(String factoryName,
 String folderName,
 Map<String,Object> context)
                                 throws jakarta.mail.MessagingException

Specified by:

getMailBoxActions in interface MailService

Throws:

jakarta.mail.MessagingException

sendMail

public void sendMail(String text,
 String subject,
 String factory,
 jakarta.mail.Address[] recipients)

Description copied from interface: MailService

Sends a mail using the setting of this factory to this recipients.

The context is passed to the sessionFactory to be able to find the session. Use the default session if context is not used. This template is used, replacing variables with the ones from this variables.

Specified by:

sendMail in interface MailService

sendMail

public void sendMail(String text,
 String subject,
 String factory,
 jakarta.mail.Address[] recipients,
 Map<String,Object> context)

Specified by:

sendMail in interface MailService

getFetcher

public PropertiesFetcher getFetcher(String name)

Specified by:

getFetcher in interface MailService

getPipe

public MessageActionPipe getPipe(String name)

Description copied from interface: MailService

Gets the pipe of actions for given name

Specified by:

getPipe in interface MailService

newSession

protected jakarta.mail.Session newSession(Properties props)