com.adobe.cq.social.commons.emailreply

Interface EmailClientProvider

public interface EmailClientProvider

The EmailClientProvider specifies the contract for different email client service providers. EmailClientProvider services are used to parse relevant information (like post, post author, etc) from mail message. Whether the EmailClientProvider can parse given mailMessage can be checked using acceptsMail() method. For EmailClientProvider which parses mailMessage for creation of post, mandatory set of properties which needs to be parsed are email.message and email.author.id. EmailClientProvider services has been intended to provide dynamic support for various email clients like gmail, outlook which use different patterns of quoted text in their reply email. Abstract implementation is provided by ctEmailClientProvider.java

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMAIL_AUTHOR_PROPERTY Property for author of email, i.e.
static java.lang.String	EMAIL_MESSAGE_PROPERTY Property for message contents parsed from email body.
static java.lang.String	EMAIL_SUBJECT_PROPERTY Property for subject of email.

Method Summary

Modifier and Type	Method and Description
boolean	acceptsMail(MimeMessage mailMessage) Returns true if mailMessage can be parsed using this EmailClientProvider else false.
java.lang.String	getEmailContent(MimeMessage mailMessage) Returns mailMessage content.
java.util.Properties	getMailProperties(EmailReplyConfiguration configuration, MimeMessage mailMessage) Returns a set of mail properties parsed from mailMessage.
int	getPriorityOrder() Returns the priority rank deciding the order in which this email client provider will be used to parse reply emails.

Field Detail

EMAIL_MESSAGE_PROPERTY

static final java.lang.String EMAIL_MESSAGE_PROPERTY

Property for message contents parsed from email body.

See Also:

Constant Field Values

EMAIL_AUTHOR_PROPERTY

static final java.lang.String EMAIL_AUTHOR_PROPERTY

Property for author of email, i.e. "From" address.

See Also:

Constant Field Values

EMAIL_SUBJECT_PROPERTY

static final java.lang.String EMAIL_SUBJECT_PROPERTY

Property for subject of email.

See Also:

Constant Field Values

Method Detail

acceptsMail

boolean acceptsMail(MimeMessage mailMessage)

Returns true if mailMessage can be parsed using this EmailClientProvider else false. In context of post from inbound mail functionality, this method can check whether quoted text pattern in reply mail be identified and removed by this EmailClientProvider to get post message.

Parameters:

mailMessage - mail to be parsed

Returns:

true if parsing is possible else false

getMailProperties

java.util.Properties getMailProperties(EmailReplyConfiguration configuration,
                                       MimeMessage mailMessage)

Returns a set of mail properties parsed from mailMessage. In context of post from inbound mail functionality, mandatory parameters to be parsed are email.message and email.author.id.

Parameters:

configuration - current EmailReplyConfiguration implementation

mailMessage - mail whose properties is to be parsed

Returns:

mail properties parsed from mailMessage. Empty property if no relevant property can be parsed

getEmailContent

java.lang.String getEmailContent(MimeMessage mailMessage)
                          throws java.io.IOException,
                                 MessagingException

Returns mailMessage content. If content is instance of String, it is returned. In case content is instance of Multipart , first part with content type "text/plain" is returned. Quoted text, in case of reply emails, is not pruned from content. Can be extended by implementations for more complex parsing of mail content.

Parameters:

mailMessage - mail whose content is to be read

Returns:

mail content. Empty String if content is null

Throws:

java.io.IOException - thrown by MimeMessage DataHandler

MessagingException - thrown by MimeMessage DataHandler

getPriorityOrder

int getPriorityOrder()

Returns the priority rank deciding the order in which this email client provider will be used to parse reply emails.

Returns:

priority order