Package com.javahollic.jira.emh.api
Interface IJEMHMessageMetaData
-
- All Superinterfaces:
IJEMHDistListMetaData
public interface IJEMHMessageMetaData extends IJEMHDistListMetaData
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddFinalRecipientUserKey(String userKey)Set<javax.mail.internet.InternetAddress>getAllCatchEmailMatches()Set<javax.mail.internet.InternetAddress>getBccRecipients()javax.mail.internet.InternetAddressgetCatchEmailMatch()Set<javax.mail.internet.InternetAddress>getDistGroupAddresses()List<CatchEmailResult>getDomainRuleCatchEmailMatches()StringgetFilterReasonMessage()List<javax.mail.internet.InternetAddress>getFinalRecipients()Set<String>getFinalRecipientUserKeys()javax.mail.internet.InternetAddressgetFrom()List<javax.mail.internet.InternetAddress>getInitialRecipients()com.javahollic.jira.emh.api.ao.IJEMHFPAuditEventEntiyDef.ProcessingOutcomegetOutcome()javax.mail.MessagegetPostProcessedMessage()StringgetSubject()com.javahollic.jira.emh.api.ao.IJEMHFPAuditEventEntiyDef.ProcessingOutcomeinit()
-
-
-
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
List<javax.mail.internet.InternetAddress> getInitialRecipients()
- Specified by:
getInitialRecipientsin interfaceIJEMHDistListMetaData- Returns:
- the uniqiue set of message recipients, To/Cc and possibly Bcc header resolved, prior to LDAP group expansion
-
getFinalRecipients
List<javax.mail.internet.InternetAddress> getFinalRecipients()
- Specified by:
getFinalRecipientsin interfaceIJEMHDistListMetaData- 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()
- Specified by:
getFinalRecipientUserKeysin interfaceIJEMHDistListMetaData- Returns:
- the registered JIRA user 'userkeys' of recipients
-
addFinalRecipientUserKey
void addFinalRecipientUserKey(String userKey)
-
getDistGroupAddresses
Set<javax.mail.internet.InternetAddress> getDistGroupAddresses()
- Specified by:
getDistGroupAddressesin interfaceIJEMHDistListMetaData- 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
-
getDomainRuleCatchEmailMatches
List<CatchEmailResult> getDomainRuleCatchEmailMatches()
- Returns:
- List of CatchEmailResults which include an address and the domain rule which was matched which relate to a catch email address
-
getAllCatchEmailMatches
Set<javax.mail.internet.InternetAddress> getAllCatchEmailMatches()
- Returns:
- SET of addresses of all catchemail addresses found for 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
com.javahollic.jira.emh.api.ao.IJEMHFPAuditEventEntiyDef.ProcessingOutcome getOutcome()
- Returns:
- if message is null outcome will be "forward" otherwise "canHandle"
-
getPostProcessedMessage
javax.mail.Message getPostProcessedMessage()
-
init
com.javahollic.jira.emh.api.ao.IJEMHFPAuditEventEntiyDef.ProcessingOutcome init()
-
-