org.nuxeo.ecm.platform.mail.service
Interface MailService

All Known Implementing Classes:

MailServiceImpl

public interface MailService

Author:

Alexandre Russel

Method Summary

Store	getConnectedStore(String name) Returns a connected store for this factory.
Store	getConnectedStore(String name, Map<String,Object> context)
Transport	getConnectedTransport(String name) Returns a connected transport for this factory.
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
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.
Session	getSession(String name, Map<String,Object> context)
void	sendMail(String text, String subject, String factory, Address[] recipients) Sends a mail using the setting of this factory to this recipients.
void	sendMail(String text, String subject, String factory, Address[] recipients, Map<String,Object> context)

Method Detail

getMailBoxActions

MailBoxActions getMailBoxActions(String factoryName,
                                 String folderName)
                                 throws Exception

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.

Throws:

Exception

getMailBoxActions

MailBoxActions getMailBoxActions(String factoryName,
                                 String folderName,
                                 Map<String,Object> context)
                                 throws Exception

Throws:

Exception

getPipe

MessageActionPipe getPipe(String name)

Gets the pipe of actions for given name

sendMail

void sendMail(String text,
              String subject,
              String factory,
              Address[] recipients)
              throws Exception

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.

Throws:

Exception

sendMail

void sendMail(String text,
              String subject,
              String factory,
              Address[] recipients,
              Map<String,Object> context)
              throws Exception

Throws:

Exception

getConnectedStore

Store getConnectedStore(String name)
                        throws Exception

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

Parameters:

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

Returns:

the store.

Throws:

Exception

getConnectedStore

Store getConnectedStore(String name,
                        Map<String,Object> context)
                        throws Exception

Throws:

Exception

getConnectedTransport

Transport getConnectedTransport(String name)
                                throws Exception

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

Parameters:

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

Returns:

the transport.

Throws:

Exception

getConnectedTransport

Transport getConnectedTransport(String name,
                                Map<String,Object> context)
                                throws Exception

Throws:

Exception

getSession

Session getSession(String name)
                   throws Exception

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

Throws:

Exception

getSession

Session getSession(String name,
                   Map<String,Object> context)
                   throws Exception

Throws:

Exception

getFetcher

PropertiesFetcher getFetcher(String name)
                             throws Exception

Throws:

Exception