com.canto.cumulus.db.mail

Class MailManager

java.lang.Object

com.canto.cumulus.db.mail.MailManager

public class MailManager
extends java.lang.Object

Provides access to the Mail-Infrastructure of the Cumulus server.

Since:

8.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MailManager.EmailContentType
static interface	MailManager.PlaceholderProvider

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteMessages(java.util.List<GUID> messageIDs) Deletes all given messages at the server if not sent already.
CumulusSession	getCumulusSession() Returns the CumulusSession for this MailManager.
static MailManager	getInstance(Server server) Returns the singleton instance of the MailManager for the given server.
MailServerConfigurations	getMailServerConfigurations() Returns all mail server configurations.
java.util.List<MailMessage>	getQueueInformation() Returns the queue of the messages at the server.
Server	getServer() Returns the server instance of this mail manager.
void	sendMessage(int languageID, GUID mailClassID, java.lang.String templateName, MailManager.PlaceholderProvider placeholderProvider, java.lang.String from, java.lang.String recipients, java.lang.String ccRecipients, java.lang.String bccRecipients, java.util.Collection<Asset> assetsToAttach) Sends a message dynamically constructed from an email template.
void	sendMessage(java.lang.String from, java.lang.String recipients, java.lang.String ccRecipients, java.lang.String bccRecipients, java.lang.String subject, java.lang.String bodyText, java.util.Collection<Asset> assetsToAttach) Sends a message.
void	sendNotificationMessage(MailServerConfiguration.NotificationsLevel level, java.lang.String message) Sends a notification message to the administrator of the cumulus server.
void	sendTestMessage(int languageID, GUID mailClassID, java.lang.String templateName, MailManager.PlaceholderProvider placeholderProvider, java.lang.String from, java.lang.String recipients, java.lang.String ccRecipients, java.lang.String bccRecipients, java.util.Collection<Asset> assetsToAttach) Sends a test message dynamically constructed from an email template.
java.util.List<MailAddress>	validateAddresses(java.lang.String addresses) Converts the email addresses in the given string into a list of parsed email addresses.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static MailManager getInstance(Server server)

Returns the singleton instance of the MailManager for the given server.

Parameters:

server - server providing the mail infrastructure

Returns:

instance of the MailManager to work with

getServer

public Server getServer()

Returns the server instance of this mail manager.

Returns:

server instance of this mail manager

Since:

9.2

getCumulusSession

public CumulusSession getCumulusSession()

Returns the CumulusSession for this MailManager.

Returns:

CumulusSession for this MailManager

sendTestMessage

public void sendTestMessage(int languageID,
                   GUID mailClassID,
                   java.lang.String templateName,
                   MailManager.PlaceholderProvider placeholderProvider,
                   java.lang.String from,
                   java.lang.String recipients,
                   java.lang.String ccRecipients,
                   java.lang.String bccRecipients,
                   java.util.Collection<Asset> assetsToAttach)

Sends a test message dynamically constructed from an email template. This method enables sending messages for disabled email templates.

Parameters:

languageID - the language to use for the email

mailClassID - ID of the email class to read the template from

templateName - name of the template within the email class, or null if the default template should be selected automatically

placeholderProvider - provider for additional placeholder values or null if no additional placeholder should be resolved

from - sender or null if not applicable

recipients - required list of recipients

ccRecipients - list of cc-recipients or null

bccRecipients - list of bcc-recipients or null

assetsToAttach - list of assets to attach to the message or null

Since:

9.2

sendMessage

public void sendMessage(int languageID,
               GUID mailClassID,
               java.lang.String templateName,
               MailManager.PlaceholderProvider placeholderProvider,
               java.lang.String from,
               java.lang.String recipients,
               java.lang.String ccRecipients,
               java.lang.String bccRecipients,
               java.util.Collection<Asset> assetsToAttach)

Sends a message dynamically constructed from an email template.

Parameters:

languageID - the language to use for the email

mailClassID - ID of the email class to read the template from

templateName - name of the template within the email class, or null if the default template should be selected automatically

placeholderProvider - provider for additional placeholder values or null if no additional placeholder should be resolved

from - sender or null if not applicable

recipients - required list of recipients

ccRecipients - list of cc-recipients or null

bccRecipients - list of bcc-recipients or null

assetsToAttach - list of assets to attach to the message or null

Since:

9.2

sendMessage

public void sendMessage(java.lang.String from,
               java.lang.String recipients,
               java.lang.String ccRecipients,
               java.lang.String bccRecipients,
               java.lang.String subject,
               java.lang.String bodyText,
               java.util.Collection<Asset> assetsToAttach)
                 throws CumulusException

Sends a message.

Parameters:

from - sender or null if not applicable

recipients - required list of recipients

ccRecipients - list of cc-recipients or null

bccRecipients - list of bcc-recipients or null

subject - subject of the message or null

bodyText - body of the message or null

assetsToAttach - list of assets to attach to the message or null

Throws:

CumulusException - in case of an error

sendNotificationMessage

public void sendNotificationMessage(MailServerConfiguration.NotificationsLevel level,
                           java.lang.String message)
                             throws CumulusException

Sends a notification message to the administrator of the cumulus server.

Parameters:

level - level of this message

message - message text

Throws:

CumulusException - if some error happens while communicating with the cumulus server

getQueueInformation

public java.util.List<MailMessage> getQueueInformation()

Returns the queue of the messages at the server. Needs PredefinedPermissions.SERVER_PERMISSION_MAIL_ADMIN permission.

Returns:

list of messages in the queue

validateAddresses

public java.util.List<MailAddress> validateAddresses(java.lang.String addresses)
                                              throws CumulusException

Converts the email addresses in the given string into a list of parsed email addresses.

Parameters:

addresses - comma or semicolon separated list of email addresses using RFC822 format

Returns:

list of parsed addresses

Throws:

CumulusException - in case of an invalid part for one of the email addresses

Since:

9.0

deleteMessages

public void deleteMessages(java.util.List<GUID> messageIDs)

Deletes all given messages at the server if not sent already. Needs PredefinedPermissions.SERVER_PERMISSION_MAIL_ADMIN permission.

Parameters:

messageIDs - message IDs of the messages to delete

getMailServerConfigurations

public MailServerConfigurations getMailServerConfigurations()
                                                     throws CumulusException

Returns all mail server configurations. Needs PredefinedPermissions.SERVER_PERMISSION_MAIL_ADMIN permission.

Returns:

all available mail server configurations

Throws:

CumulusException - in case of an error