com.javahollic.jira.emh.api

Interface IJEMHMessageMetaData

public interface IJEMHMessageMetaData

This interface collates extracted meta-data from the message that are possibly timely to produce, as a performance measure eg. LDAP distribution-group expansion, resolution of JIRA userkeys for all participants; such values when found would be cached to minimise network churn

Author:

andy

Method Summary

Modifier and Type	Method and Description
Set<javax.mail.internet.InternetAddress>	getBccRecipients()
javax.mail.internet.InternetAddress	getCatchEmailMatch()
Set<javax.mail.internet.InternetAddress>	getDistGroupAddresses()
String	getFilterReasonMessage()
Set<javax.mail.internet.InternetAddress>	getFinalRecipients()
Set<String>	getFinalRecipientUserKeys()
javax.mail.internet.InternetAddress	getFrom()
Set<javax.mail.internet.InternetAddress>	getInitialRecipients()
IJEMHMessageFilterProvider.ProcessOutcome	getOutcome()
javax.mail.Message	getPostProcessedMessage()
String	getSubject()
IJEMHMessageFilterProvider.ProcessOutcome	init()

Method Detail

getFilterReasonMessage

String getFilterReasonMessage()

getFrom

javax.mail.internet.InternetAddress getFrom()
                                     throws javax.mail.MessagingException

Returns:

the resolve From address, bearing in mind the Profile From/ReplyTo parse order setting

Throws:

javax.mail.MessagingException - due to from address parsing failure

getInitialRecipients

Set<javax.mail.internet.InternetAddress> getInitialRecipients()

Returns:

the uniqiue set of message recipients, To/Cc and possibly Bcc header resolved, prior to LDAP group expansion

getFinalRecipients

Set<javax.mail.internet.InternetAddress> getFinalRecipients()

Returns:

the uniqiue set of message recipients, To/Cc and possibly Bcc header resolved. Also for those recipients, LDAP dist-group expansion could be applied. Does not contain the actual distribution group addresses, see getDistGroupAddresses

getFinalRecipientUserKeys

Set<String> getFinalRecipientUserKeys()

Returns:

the registered JIRA user 'userkeys' of recipients

getDistGroupAddresses

Set<javax.mail.internet.InternetAddress> getDistGroupAddresses()

Returns:

email addresses relating to LDAP distribution groups, split out from the general recipients, so that these addresses can be used by catchemail matching, but separated from FinalRecipients for user creation

getBccRecipients

Set<javax.mail.internet.InternetAddress> getBccRecipients()

Returns:

email address found through configured bcc headers (eg Delivered-To:)

getCatchEmailMatch

javax.mail.internet.InternetAddress getCatchEmailMatch()

Returns:

address of the first catchemail address or regexp to match any recipient address, including those identified through LDAP expansion

getSubject

String getSubject()

Returns:

the email subject after profile level subject cleanup regexp's have been applied

getOutcome

IJEMHMessageFilterProvider.ProcessOutcome getOutcome()

Returns:

if message is null outcome will be "forward" otherwise "canHandle"

getPostProcessedMessage

javax.mail.Message getPostProcessedMessage()

init

IJEMHMessageFilterProvider.ProcessOutcome init()