Package com.day.cq.mailer

Interface MailingService

public interface MailingService

Service Interface to send a Mailing
A Mailing is a MessageTemplate that is intended to be send to a List of recipients.

Since:

5.4

Method Summary

Modifier and Type	Method	Description
MailingStatus	getStatus(java.lang.String mailingId)	Deprecated. It's recommended to use getStatus(String, javax.jcr.Session) instead.
MailingStatus	getStatus(java.lang.String mailingId, javax.jcr.Session session)
MailingStatus	send(MessageTemplate message, AuthorizableMailingList recipients, ResourceResolver resourceResolver)	Send a Mailing to.

Method Detail

getStatus

@Deprecated
MailingStatus getStatus(java.lang.String mailingId)
                 throws javax.jcr.RepositoryException

Deprecated.

It's recommended to use getStatus(String, javax.jcr.Session) instead.

Parameters:

mailingId - to access the MailingStatus

Returns:

or null if the mailing has not be sent does not exist

Throws:

javax.jcr.RepositoryException - in case of an exception accessing the Repository

See Also:

;

getStatus

MailingStatus getStatus(java.lang.String mailingId,
                        javax.jcr.Session session)
                 throws javax.jcr.RepositoryException

Parameters:

mailingId - to access the MailingStatus

session - to read the Node having MailingStatus

Returns:

or null if the mailing has not be sent does not exist

Throws:

javax.jcr.RepositoryException - in case of an exception accessing the Repository

See Also:

;

send

MailingStatus send(MessageTemplate message,
                   AuthorizableMailingList recipients,
                   ResourceResolver resourceResolver)
            throws MailingException,
                   javax.jcr.RepositoryException

Send a Mailing to.

Parameters:

message - to be send

recipients - of the message

resourceResolver - Resource resolver

Returns:

the mailing created for send

Throws:

MailingException - in case the sending could not be started

javax.jcr.AccessDeniedException - in case the session lacks privileges to send the Mailing

javax.jcr.RepositoryException - in case of error accessing the Repository

MailingException - If an error occurs