com.adobe.cq.social.commons.emailreply

Interface CommentEmailBuilder

public interface CommentEmailBuilder

The CommentEmailBuilder builds Emails based on the given ResourceResolvers, SocialActivity and recipient user id. As well builder uses EmailContent of the unsuccessful reply emails to build failure notification email. The builder is OSGi service that is looked up as service references while sending an email for an occurring notification.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TRACKER_ID_PROPERTY Property unique tracker id of comment resource to which comment parsed from email is to be added.

Method Summary

Modifier and Type	Method and Description
Email	build(java.lang.String emailConfigurationName, ResourceResolver ugcWriterResourceResolver, ResourceResolver userReaderResourceResolver, ResourceResolver utilityReaderResourceResolver, java.util.Map<java.lang.String,java.lang.Object> templateValues, java.lang.String emailTemplateResourceRootPath, java.lang.String recipient) Builds an email message from the given resource resolvers, social activity, recipient user id and reply-to email address.
Email	build(java.lang.String emailConfigurationName, ResourceResolver ugcWriterResourceResolver, ResourceResolver userReaderResourceResolver, ResourceResolver utilityReaderResourceResolver, SocialActivity socialActivity, java.lang.String recipientUserId) Builds an email message from the given resource resolvers, social activity, recipient user id and reply-to email address.
Email	buildFailure(java.lang.String emailConfigurationName, ResourceResolver userReaderResourceResolver, ResourceResolver utilityReaderResourceResolver, EmailContent replyEmailContent) Builds an email failure message from the given resource resolvers and reply email content.

Field Detail

TRACKER_ID_PROPERTY

static final java.lang.String TRACKER_ID_PROPERTY

Property unique tracker id of comment resource to which comment parsed from email is to be added.

See Also:

Constant Field Values

Method Detail

build

Email build(java.lang.String emailConfigurationName,
            ResourceResolver ugcWriterResourceResolver,
            ResourceResolver userReaderResourceResolver,
            ResourceResolver utilityReaderResourceResolver,
            SocialActivity socialActivity,
            java.lang.String recipientUserId)

Builds an email message from the given resource resolvers, social activity, recipient user id and reply-to email address.

Parameters:

emailConfigurationName - name of EmailReplyConfiguration to build email

ugcWriterResourceResolver - the resource resolver used to obtain the resource in the JCR

userReaderResourceResolver - the resource resolver used to obtain access to the users directory

utilityReaderResourceResolver - the resource resolver used to obtain access to the email templates directory

socialActivity - social activity based on any subscribable comment event

recipientUserId - recipient user id

Returns:

built email

buildFailure

Email buildFailure(java.lang.String emailConfigurationName,
                   ResourceResolver userReaderResourceResolver,
                   ResourceResolver utilityReaderResourceResolver,
                   EmailContent replyEmailContent)

Builds an email failure message from the given resource resolvers and reply email content.

Parameters:

emailConfigurationName - name of EmailReplyConfiguration to build email

userReaderResourceResolver - the resource resolver used to obtain access to the users directory

utilityReaderResourceResolver - the resource resolver used to obtain access to the email templates directory

replyEmailContent - the content of the unsuccessful reply email

Returns:

built failure notification email

build

Email build(java.lang.String emailConfigurationName,
            ResourceResolver ugcWriterResourceResolver,
            ResourceResolver userReaderResourceResolver,
            ResourceResolver utilityReaderResourceResolver,
            java.util.Map<java.lang.String,java.lang.Object> templateValues,
            java.lang.String emailTemplateResourceRootPath,
            java.lang.String recipient)

Builds an email message from the given resource resolvers, social activity, recipient user id and reply-to email address.

Parameters:

emailConfigurationName - name of EmailReplyConfiguration to build email

ugcWriterResourceResolver - the resource resolver used to obtain the resource in the JCR

userReaderResourceResolver - the resource resolver used to obtain access to the users directory

utilityReaderResourceResolver - the resource resolver used to obtain access to the email templates directory

templateValues - the email template values

emailTemplateResourceRootPath - the email template Resource

recipient - the recipient user id

Returns:

built email