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

Methods

Modifier and Type	Method and Description
MailingStatus	getStatus(String mailingId)
MailingStatus	send(MessageTemplate message, AuthorizableMailingList recipients, ResourceResolver resourceResolver) Send a Mailing to.
MailingStatus	send(MessageTemplate message, MailingList recipients, Session session) Deprecated.

Method Detail

getStatus

MailingStatus getStatus(String mailingId)
                        throws RepositoryException

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

RepositoryException

See Also:

;

send

@Deprecated
MailingStatus send(MessageTemplate message,
                            MailingList recipients,
                            Session session)
                   throws MailingException,
                          RepositoryException

Deprecated.

Send a Mailing to.

Parameters:

message - to be send

recipients - of the message

session - to use for sending the mailing

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

RepositoryException - in case of error accessing the Repository Deprecated because of MailingList which depends on Authorizable, use #send(MessageTemplate, AuthorizableMailingList, javax.jcr.Session, org.apache.sling.api.resource.ResourceResolver)

send

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

Send a Mailing to.

Parameters:

message - to be send

recipients - of the message

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

RepositoryException - in case of error accessing the Repository