IJEMHVelocityContextUtils (jemh-api 3.2.5 API)

```
public interface IJEMHVelocityContextUtils
```
Velocity Context helper interface, accessed vie email templates, used to inhibit mail sending, for now.. published url: http://ppl-docs.s3-website-us-east-1.amazonaws.com/JEMH/3.0.0/com/javahollic/jira/emh/api/IJEMHVelocityContextUtils.html

Author:

andy

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IJEMHVelocityContextUtils.InlineImageEncodingType

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IJEMHVelocityContextUtils.InlineImageEncodingType`

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addMailHeader(String key, String value)` Adds a mail header to the outgoing mail.
`void`	`addRawMailHeader(String key, String value)` Adds a mail header that is not prefixed.
`void`	`addRecipientAddress(String recipientType, String addressCsv)` Adds recipients through CSV SMTP address
`void`	`addRecipientGroup(String recipientType, String groupName)` Adds recipients from a given Jira group
`void`	`addRecipientsFromRole(String recipientType, String issueKey, com.atlassian.jira.project.Project project, String roleName)` Add recipients based on Role membership
`String`	`addStaticResourceAttachment(Integer id)` Add a global (unscoped) static resource by its Id.
`String`	`addStaticResourceAttachment(com.atlassian.jira.project.Project project, Integer id)` Add a static resource (scoped to project) by its Id
`Map<String,Object>`	`createResultSet()` Enable scripts to create multiple issue,by creating an additional (possibly many) new result sets containing key/value paris as usual
`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
`String`	`getCalData()` Get the content of the text/calendar message part
`javax.mail.internet.InternetAddress`	`getCatchEmailAddress()`
`Properties`	`getCommentProperties(com.atlassian.jira.issue.comments.Comment comment)` Get comment properties
`Map<String,Integer>`	`getImageCidMap()` Internal use
`String`	`getInhibitSendingReason()` Gets the reason that was possibly set by the processing script why this message was inhibited for sending
`IJEMHLdapVelocityContextUtil`	`getLdap()` Create an Ldap helper that enables querying through LDAP configurations selected in the Profile
`com.atlassian.jira.util.I18nHelper`	`getLocaleI18nBean(String localeIn)` Get a specific locale i18n helper
`String`	`getMessageBody(javax.mail.Message message)` Get the body (according to htmL to wiki conversion configuration in the Profile)
`String`	`getMessagePartText(String contentType)`
`List<javax.mail.Message>`	`getMessageSubParts(javax.mail.internet.MimeMessage parentMessage)` Get the child attachment Parts that are message/rfc822
`Map<String,List<String>>`	`getParams()` Accessor for Map of value keys to list of values
`IJEMHMessageFilterProvider.ProcessOutcome`	`getProcessOutcome()` Accessor method to get script driven outcome of message processing that would override future processing/outcome.
`String`	`getRejectReason()` Get the message that may be set to describe why a message was rejected, ends up in audit record.
`Collection<Map<String,Object>>`	`getResultSets()` Accessor method to expose any additional ResultSets created by the script
`TimeZone`	`getTimeZone(String location)`
`URI`	`getUserAvatarURL(com.atlassian.jira.user.ApplicationUser user, int size)` Enable the URI of a user avatar to be retrieved for inlining
`com.atlassian.jira.user.ApplicationUser`	`getUserByEmail(javax.mail.internet.InternetAddress address)` Helper method to get a User
`com.atlassian.jira.user.ApplicationUser`	`getUserByEmail(String emailStr)` Helper method to bet a User
`String`	`hash(String stringToEncrypt)` Function to allow hashing of arbitrary content, eg summary, eg description, for storing in custom fields, to potentially detect future resends of same content/description even after the initial issue was edited
`com.atlassian.jira.util.json.JSONObject`	`invokeLocalAnonRest(String path)` Make an anonymous HTTP request relative to the local Jira path
`com.atlassian.jira.util.json.JSONObject`	`invokeLocalRest(String path)` Make a HTTP request relative to the local Jira path
`boolean`	`isCustomFieldChanged(com.atlassian.jira.event.issue.IssueEvent issueEvent, String cfId)` Used to determine during outbound processing, whether the given custom field id was in a ChildChangeItem of the event
`boolean`	`isInhibitSending()` determine if the outcome of the script is to inhibit sending of 'this' notification
`boolean`	`isPrivateJSDComment(com.atlassian.jira.user.ApplicationUser contextUser, com.atlassian.jira.issue.comments.Comment c)` Helper method to determine if a comment is JSD private
`boolean`	`isPrivateJSDComment(com.atlassian.jira.mail.TemplateUser contextTemplateUser, com.atlassian.jira.issue.comments.Comment c)` Helper method to determine if a comment is JSD private, which is required during actual mail sending
`void`	`log(String msg)` Log an INFO message to the JEMH log file
`void`	`log(String level, String msg)` Output a message to the JEMH log file
`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
`String`	`renderStaticResourceImage(Integer id)` Render a given static resource image (unscoped) inline.
`String`	`renderStaticResourceImage(com.atlassian.jira.project.Project project, Integer id)` Render a given static resource image (scoped to the given project) inline.
`String`	`renderStaticResourceImage(com.atlassian.jira.project.Project project, Integer id, String type)` Render a given static resource image (scoped to the given project) inline.
`com.atlassian.jira.util.json.JSONObject`	`request(Map<String,Object> options)` Perform a custom HTTP request
`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)` Sets a reason, retained in the audit entry to indicate why this message was inhibited for sending
`String`	`urlencode(String incoming)` Helper method to urlencode(UTF-8) a string in Java context:

- 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
  - getCalData
```
String getCalData()
```
    Get the content of the text/calendar message part
    
    Returns:
    
    the content as a String.
  - getTimeZone
```
TimeZone getTimeZone(String location)
```
    Parameters:
    
    location - for which the timeZone is needed
    
    Returns:
    
    TimeZone of the passed in location
  - getCatchEmailAddress
```
javax.mail.internet.InternetAddress getCatchEmailAddress()
```
    Returns:
    
    catch email address that matched for profile
  - 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()
```
    determine if the outcome of the script is to inhibit sending of 'this' notification
    
    Returns:
    
    true if is to inhibit
  - setInhibitSendingReason
```
void setInhibitSendingReason(String reason)
```
    Sets a reason, retained in the audit entry to indicate why this message was inhibited for sending
    
    Parameters:
    
    reason - as text
  - getInhibitSendingReason
```
String getInhibitSendingReason()
```
    Gets the reason that was possibly set by the processing script why this message was inhibited for sending
    
    Returns:
    
    reason
  - isPrivateJSDComment
```
boolean isPrivateJSDComment(com.atlassian.jira.user.ApplicationUser contextUser,
                            com.atlassian.jira.issue.comments.Comment c)
```
    Helper method to determine if a comment is JSD private
    
    Parameters:
    
    contextUser, - the context for the question
    
    c, - related comment
    
    Returns:
    
    true if JSD is installed, and comment is private
  - isPrivateJSDComment
```
boolean isPrivateJSDComment(com.atlassian.jira.mail.TemplateUser contextTemplateUser,
                            com.atlassian.jira.issue.comments.Comment c)
```
    Helper method to determine if a comment is JSD private, which is required during actual mail sending
    
    Parameters:
    
    contextTemplateUser, - the contextTemplateUser for the question
    
    c, - related comment
    
    Returns:
    
    true if JSD is installed, and comment is private
  - getCommentProperties
```
Properties getCommentProperties(com.atlassian.jira.issue.comments.Comment comment)
```
    Get comment properties
    
    Parameters:
    
    comment - to get properties of
    
    Returns:
    
    java.util.Properties object
  - addMailHeader
```
void addMailHeader(String key,
                   String value)
```
    Adds a mail header to the outgoing mail. Any additional processed to make the header valid is the responsibility of the caller.
    
    Parameters:
    
    key - text, all spaces in the value are removed, the result is prefixed by X-JEMH-ADHOC-
    
    value - text, should be relatively short. We don't wrap or encode the data supplied
  - addRawMailHeader
```
void addRawMailHeader(String key,
                      String value)
```
    Adds a mail header that is not prefixed. It is the callers responsilbity to ensure it is valid. Caller should NOT use recipient headers (to/cc/bcc)!
    
    Parameters:
    
    key, - usually of format X-something-else
    
    value, - text, should be relatively short. We don't wrap or encode the data supplied
  - addRecipientsFromRole
```
void addRecipientsFromRole(String recipientType,
                           String issueKey,
                           com.atlassian.jira.project.Project project,
                           String roleName)
```
    Add recipients based on Role membership
    
    Parameters:
    
    issueKey - eg ABC-123
    
    project - from the issue
    
    roleName - eg "Customers"
    
    recipientType - eg "to" or "cc" (only)
  - addRecipientAddress
```
void addRecipientAddress(String recipientType,
                         String addressCsv)
```
    Adds recipients through CSV SMTP address
    
    Parameters:
    
    recipientType, - valid values are to and cc
    
    addressCsv, - valid values are of format user@domain.com, NO Name parts are supported.
  - addRecipientGroup
```
void addRecipientGroup(String recipientType,
                       String groupName)
```
    Adds recipients from a given Jira group
    
    Parameters:
    
    recipientType, - valid values are to and cc
    
    groupName - of Jira group
  - getParams
```
Map<String,List<String>> getParams()
```
    Accessor for Map of value keys to list of values
    
    Returns:
    
    params, parms aggregate mail headers, but mail in future have other uses
  - getUserByEmail
```
com.atlassian.jira.user.ApplicationUser getUserByEmail(javax.mail.internet.InternetAddress address)
```
    Helper method to get a User
    
    Parameters:
    
    address - of the user as an InternetAddress object
    
    Returns:
    
    the user or null
  - getUserByEmail
```
com.atlassian.jira.user.ApplicationUser getUserByEmail(String emailStr)
```
    Helper method to bet a User
    
    Parameters:
    
    emailStr - of the user as text in format user@domain.com, no Name part is supported.
    
    Returns:
    
    the user or null
  - 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()
```
    Accessor method to get script driven outcome of message processing that would override future processing/outcome.
    
    Returns:
    
    outcome object, .name() of which returns: canHandle, filtered, forward, reject, drop, delete, hold
  - getRejectReason
```
String getRejectReason()
```
    Get the message that may be set to describe why a message was rejected, ends up in audit record.
    
    Returns:
    
    text
  - getLocaleI18nBean
```
com.atlassian.jira.util.I18nHelper getLocaleI18nBean(String localeIn)
```
    Get a specific locale i18n helper
    
    Parameters:
    
    localeIn - the locale
    
    Returns:
    
    instance of I18nHelper
  - addStaticResourceAttachment
```
String addStaticResourceAttachment(Integer id)
```
    Add a global (unscoped) static resource by its Id.
    
    Parameters:
    
    id, - numeric ID of the Static Resource
    
    Returns:
    
    html message (not i18n), a non empty value indicates a failure, eg, a resource was referred that is not scoped to the project the event is processing
  - addStaticResourceAttachment
```
String addStaticResourceAttachment(com.atlassian.jira.project.Project project,
                                   Integer id)
```
    Add a static resource (scoped to project) by its Id
    
    Parameters:
    
    project, - the project in which the Static Resource has been scoped
    
    id, - numeric ID of the Static Resource
    
    Returns:
    
    html message (not i18n), a non empty value indicates a failure, eg, a resource was referred that is not scoped to the project the event is processing
  - renderStaticResourceImage
```
String renderStaticResourceImage(Integer id)
```
    Render a given static resource image (unscoped) inline.
    
    Parameters:
    
    id, - numeric ID of the Static Resource
    
    Returns:
    
    html to inline the related image, can also contain (non i18n) error messages if the inline failed
  - renderStaticResourceImage
```
String renderStaticResourceImage(com.atlassian.jira.project.Project project,
                                 Integer id)
```
    Render a given static resource image (scoped to the given project) inline.
    
    Parameters:
    
    project, - the project in which the Static Resource image is scoped
    
    id, - numeric ID of the Static Resource
    
    Returns:
    
    html to inline the related image, can also contain (non i18n) error messages if the inline failed, eg if not in scope
  - renderStaticResourceImage
```
String renderStaticResourceImage(com.atlassian.jira.project.Project project,
                                 Integer id,
                                 String type)
```
    Render a given static resource image (scoped to the given project) inline.
    
    Parameters:
    
    project, - the project in which the Static Resource image is scoped
    
    id, - numeric ID of the Static Resource
    
    type, - "cid" is the new default, "base64" (inline encoded data) is also valid
    
    Returns:
    
    html to inline the related image, can also contain (non i18n) error messages if the inline failed, eg if not in scope
  - getImageCidMap
```
Map<String,Integer> getImageCidMap()
```
    Internal use
    
    Returns:
    
    map of a generated CID to a given Static Resource
  - isCustomFieldChanged
```
boolean isCustomFieldChanged(com.atlassian.jira.event.issue.IssueEvent issueEvent,
                             String cfId)
```
    Used to determine during outbound processing, whether the given custom field id was in a ChildChangeItem of the event
    
    Parameters:
    
    issueEvent - involved
    
    cfId, - custom field id, of format, customfield_12345
    
    Returns:
    
    true if changed
  - urlencode
```
String urlencode(String incoming)
```
    Helper method to urlencode(UTF-8) a string in Java context:
    
    Parameters:
    
    incoming - value
    
    Returns:
    
    encoded value
  - request
```
com.atlassian.jira.util.json.JSONObject request(Map<String,Object> options)
```
    Perform a custom HTTP request
    Parameters:
    options - a Map containing the configuration options for this HTTP request
    
    url - String - the absolute (full) request URL
    
    method - String - the request method to use. GET is default.
    
    type - an alias for "method"
    
    username - String - username of the user to perform the request as
    
    timeout - String or Integer - connection timeout in milliseconds
    
    data - String - JSON data for request body. Appended to URL for GET requests. In JavaScript
    JSON.stringify(data)
    can be used to convert JSON/Object to String
    Returns:
    
    JSONObject containing the response
  - invokeLocalRest
```
com.atlassian.jira.util.json.JSONObject invokeLocalRest(String path)
```
    Make a HTTP request relative to the local Jira path
    
    Parameters:
    
    path - of local rest call, relative to Jira's base URL
    
    Returns:
    
    JSONObject containing the response body (if present)
  - invokeLocalAnonRest
```
com.atlassian.jira.util.json.JSONObject invokeLocalAnonRest(String path)
                                                     throws com.atlassian.jira.util.json.JSONException
```
    Make an anonymous HTTP request relative to the local Jira path
    
    Parameters:
    
    path - of local rest call, relative to Jira's base URL
    
    Returns:
    
    JSONObject containing the response body (if present)
    
    Throws:
    
    com.atlassian.jira.util.json.JSONException - if it breaks
  - hash
```
String hash(String stringToEncrypt)
     throws NoSuchAlgorithmException,
            UnsupportedEncodingException
```
    Function to allow hashing of arbitrary content, eg summary, eg description, for storing in custom fields, to potentially detect future resends of same content/description even after the initial issue was edited
    
    Parameters:
    
    stringToEncrypt - eg summary / body
    
    Returns:
    
    digest of the data
    
    Throws:
    
    NoSuchAlgorithmException - if it breaks
    
    UnsupportedEncodingException - if it breaks
  - createResultSet
```
Map<String,Object> createResultSet()
```
    Enable scripts to create multiple issue,by creating an additional (possibly many) new result sets containing key/value paris as usual
    
    Returns:
    
    map of values to initialize an issue, e.g. project="ABC", issueType="bug" etc.
  - getResultSets
```
Collection<Map<String,Object>> getResultSets()
```
    Accessor method to expose any additional ResultSets created by the script
    
    Returns:
    
    collection of result sets
  - log
```
void log(String level,
         String msg)
```
    Output a message to the JEMH log file
    
    Parameters:
    
    level - the log level for the output: DEBUG, INFO, WARN, ERROR
    
    msg - the message to log
  - log
```
void log(String msg)
```
    Log an INFO message to the JEMH log file
    
    Parameters:
    
    msg - the message to log
  - getMessageSubParts
```
List<javax.mail.Message> getMessageSubParts(javax.mail.internet.MimeMessage parentMessage)
```
    Get the child attachment Parts that are message/rfc822
    
    Parameters:
    
    parentMessage - the Mime message
    
    Returns:
    
    child parts loaded as Message objects to allow further processing
  - getMessagePartText
```
String getMessagePartText(String contentType)
```
  - getMessageBody
```
String getMessageBody(javax.mail.Message message)
```
    Get the body (according to htmL to wiki conversion configuration in the Profile)
    
    Parameters:
    
    message - source
    
    Returns:
    
    wiki markup extracted
  - getLdap
```
IJEMHLdapVelocityContextUtil getLdap()
```
    Create an Ldap helper that enables querying through LDAP configurations selected in the Profile
    
    Returns:
    
    ldap util support class
  - getUserAvatarURL
```
URI getUserAvatarURL(com.atlassian.jira.user.ApplicationUser user,
                     int size)
```
    Enable the URI of a user avatar to be retrieved for inlining
    
    Parameters:
    
    user -
    
    size -
    
    Returns:
    
    URI object

Interface IJEMHVelocityContextUtils

Nested Class Summary

Field Summary

Method Summary

Field Detail

X_JEMH_ADHOC_PREFIX

X_JEMH_RAW_PREFIX

ADDITIONAL_TO

ADDITIONAL_CC

ADDITIONAL_ATTACHMENTS

Method Detail

getCalData

getTimeZone

getCatchEmailAddress

filterText

setInhibitSending

isInhibitSending

setInhibitSendingReason

getInhibitSendingReason

isPrivateJSDComment

isPrivateJSDComment

getCommentProperties

addMailHeader

addRawMailHeader

addRecipientsFromRole

addRecipientAddress

addRecipientGroup

getParams

getUserByEmail

getUserByEmail

dropMessage

forwardMessage

filterMessage

rejectMessage

getProcessOutcome

getRejectReason

getLocaleI18nBean

addStaticResourceAttachment

addStaticResourceAttachment

renderStaticResourceImage

renderStaticResourceImage

renderStaticResourceImage

getImageCidMap

isCustomFieldChanged

urlencode

request

invokeLocalRest

invokeLocalAnonRest

hash

createResultSet

getResultSets

log

log

getMessageSubParts

getMessagePartText

getMessageBody

getLdap

getUserAvatarURL