com.javahollic.jira.emh.api

Interface IJEMHVelocityContextUtils

public interface IJEMHVelocityContextUtils

Velocity Context helper interface, accessed vie email templates, used to inhibit mail sending, for now..

Author:

andy

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADDITIONAL_ATTACHMENTS
static String	ADDITIONAL_CC
static String	ADDITIONAL_TO
static String	X_JEMH_ADHOC_PREFIX used to prefix mail header keys themselves, used to avoid conflicts for issue attributes
static String	X_JEMH_RAW_PREFIX unlike the above, this is only used to uniquely store 'raw' mail headers in the 'map' prior to application

Method Summary

Modifier and Type	Method and Description
void	addMailHeader(String key, String value)
void	addRawMailHeader(String key, String value)
void	addRecipientAddress(String recipientType, String addressCsv)
void	addRecipientGroup(String recipientType, String groupName)
void	addRecipientsFromRole(String recipientType, String issueKey, com.atlassian.jira.project.Project project, String roleName)
void	dropMessage(String reason) During Script Field Processor handling of a message, allows a given message to be dropped immediately with no further processing
void	filterMessage(String reason) During Script Field Processor handling of a message, allows a given message to not be processed but filtered (like drop), here for completeness and differentation to drop
String	filterText(String text)
void	forwardMessage(String reason) During Script Field Processor handling of a message, allows a given message to not be processed but forwarded to the Profile defined 'Forward' user
Properties	getCommentProperties(com.atlassian.jira.issue.comments.Comment comment)
String	getInhibitSendingReason()
Map<String,List<String>>	getParams()
IJEMHMessageFilterProvider.ProcessOutcome	getProcessOutcome()
javax.mail.Message.RecipientType	getRecipientType(String type)
String	getRejectReason()
com.atlassian.jira.user.ApplicationUser	getUserByEmail(javax.mail.internet.InternetAddress address)
com.atlassian.jira.user.ApplicationUser	getUserByEmail(String emailStr)
boolean	isInhibitSending()
boolean	isPrivateJSDComment(com.atlassian.jira.issue.comments.Comment c)
void	rejectMessage(String reason) During Script Field Processor handling of a message, allows a given message to be rejected to the initator, with the given reason
void	setInhibitSending(boolean val) Used during sending messages to inhibit sending, specifically needed due to split phase issue creation/update to enable ignoring ISSUE_CREATED events when JEMH has not yet added attachments to the issue, that are potentially required later.
void	setInhibitSendingReason(String reason)

Field Detail

X_JEMH_ADHOC_PREFIX

static final String X_JEMH_ADHOC_PREFIX

used to prefix mail header keys themselves, used to avoid conflicts for issue attributes

See Also:

Constant Field Values

X_JEMH_RAW_PREFIX

static final String X_JEMH_RAW_PREFIX

unlike the above, this is only used to uniquely store 'raw' mail headers in the 'map' prior to application

See Also:

Constant Field Values

ADDITIONAL_TO

static final String ADDITIONAL_TO

See Also:

Constant Field Values

ADDITIONAL_CC

static final String ADDITIONAL_CC

See Also:

Constant Field Values

ADDITIONAL_ATTACHMENTS

static final String ADDITIONAL_ATTACHMENTS

See Also:

Constant Field Values

Method Detail

filterText

String filterText(String text)

Parameters:

text - to Filters the input text through some Mime decoding

Returns:

filtered input

setInhibitSending

void setInhibitSending(boolean val)

Used during sending messages to inhibit sending, specifically needed due to split phase issue creation/update to enable ignoring ISSUE_CREATED events when JEMH has not yet added attachments to the issue, that are potentially required later.

Parameters:

val, - true to inhibit

isInhibitSending

boolean isInhibitSending()

setInhibitSendingReason

void setInhibitSendingReason(String reason)

getInhibitSendingReason

String getInhibitSendingReason()

isPrivateJSDComment

boolean isPrivateJSDComment(com.atlassian.jira.issue.comments.Comment c)

getCommentProperties

Properties getCommentProperties(com.atlassian.jira.issue.comments.Comment comment)

addMailHeader

void addMailHeader(String key,
                   String value)

addRawMailHeader

void addRawMailHeader(String key,
                      String value)

addRecipientsFromRole

void addRecipientsFromRole(String recipientType,
                           String issueKey,
                           com.atlassian.jira.project.Project project,
                           String roleName)

addRecipientAddress

void addRecipientAddress(String recipientType,
                         String addressCsv)

addRecipientGroup

void addRecipientGroup(String recipientType,
                       String groupName)

getParams

Map<String,List<String>> getParams()

Returns:

params, parms aggregate mail headers, but mail in future have other uses

getRecipientType

javax.mail.Message.RecipientType getRecipientType(String type)

getUserByEmail

com.atlassian.jira.user.ApplicationUser getUserByEmail(javax.mail.internet.InternetAddress address)

getUserByEmail

com.atlassian.jira.user.ApplicationUser getUserByEmail(String emailStr)

dropMessage

void dropMessage(String reason)

During Script Field Processor handling of a message, allows a given message to be dropped immediately with no further processing

Parameters:

reason, - a non empty value used in auditing

forwardMessage

void forwardMessage(String reason)

During Script Field Processor handling of a message, allows a given message to not be processed but forwarded to the Profile defined 'Forward' user

Parameters:

reason, - a non empty value used in auditing

filterMessage

void filterMessage(String reason)

During Script Field Processor handling of a message, allows a given message to not be processed but filtered (like drop), here for completeness and differentation to drop

Parameters:

reason, - a non empty value used in auditing

rejectMessage

void rejectMessage(String reason)

During Script Field Processor handling of a message, allows a given message to be rejected to the initator, with the given reason

Parameters:

reason, - a non empty value used in auditing

getProcessOutcome

IJEMHMessageFilterProvider.ProcessOutcome getProcessOutcome()

getRejectReason

String getRejectReason()