Email This Issue
📈 Marketplace❓ Support❤️ Feedback🏠 META-INF Apps
Email This Issue - for Jira Cloud
Email This Issue - for Jira Cloud
  • ⬇️Overview
  • Email This Issue - for Jira Cloud
  • Features
  • How Email This Issue Works
  • Secure the email channel with Email This Issue
  • Comparing Email This Issue and Jira Cloud
  • 📤Outgoing Emails
    • Outgoing emails overview
    • Manual emails
      • Configuring manual emails
      • Sending manual emails
    • Email notification schemes and email notifications
    • Workflow post functions
    • Advanced email configuration
    • Customizing email templates
    • Canned Responses (default messages)
    • Scope evaluation
  • 📥Incoming Emails (Mail Handlers)
    • Incoming emails overview
  • Mail handlers - adding / editing
    • General handler settings
    • Filtering
    • Finding issues
    • Setting up rules and actions in the actions editor
      • Adding/editing actions
      • Adding recipients to Request Participants
      • Creating an issue
      • Updating an issue
      • Setting field values
      • Adding comments
      • Sending auto-reply emails
      • Executing workflow transitions
      • Creating a customer
      • Using split regexp
      • Conditions
      • Approve request
      • Decline request
    • Maintaining email chains
    • Mail Handler New UI
  • Global Sender Address Filters
  • Attachment Filters
    • Regular Attachment Handling Deprecation
  • 🤓Administration
    • Outgoing Mail Connections
    • Alerting via Webhooks
      • Webhooks
        • Configuring Slack to receive alerts via webhooks
        • Configuring OpsGenie to Receive alerts via webhooks
        • Configuring Microsoft Teams to receive alerts via webhooks
      • Webhook execution logs
    • Mail Queue
    • Email Audit Log
    • Permissions
    • Recipient Restrictions
    • Incoming Mail Connections
    • Email Security
    • Incoming Mail Queue
    • Incoming Mail Log
    • OAuth2 Credentials
      • Enabling OAuth2 Authorization in your Google Account
      • Enabling OAuth2 Authorization in your Microsoft 365 Account
      • Troubleshooting guides for Microsoft OAuth2 Connections
        • How to fix "BAD User is authenticated but not connected" error​
        • How to fix "401 Unauthorized" error
        • How to fix "key expires_in " error
        • How to fix "Need admin approval" error
  • ☁️Server to Cloud Migration
    • 🛫Server to Cloud - Automatic Migration tool
      • Preparing for the migration
      • Doing the migration
      • Finalizing the migration in Cloud
      • Migration with unsupported Jira versions causes errors
    • Server to Cloud - Manual migration guide for Email This Issue
  • ❓FAQ
    • No recipients error in outgoing emails
    • How-to add custom macro to email Template?
    • Why cannot I select custom event types in notification?
    • How to configure the Email This Issue addon user in Jira Cloud?
    • I get an error: Could not create request on behalf of the sender
    • Why is the Incoming Mail Queue size limited?
    • Outgoing mail not sent - Read timeout error
    • Access restriction icon is not appearing when adding internal attachments via Email this Issue
  • 🌪️General
    • Release Notes
    • API
      • API for Velocity Context Objects - 1.7
      • API for Velocity Context Objects
    • Addon Pages
      • Integrity Check
      • Feedback and Support
    • Security Advisories
      • Email This Issue Security Advisory September 28, 2020
    • Appendix
      • Supported Time Zones
    • Integration of Glass Documentation
Powered by GitBook
On this page
  • User
  • Issue
  • Attributes
  • Methods
  • IssueEvent
  • Comment
  • Changelog
  • ChangelogItem
  • Worklog
  • EmailCommand
  • Template Support
  • Project
  • IssueType
  • Status
  • Priority
  • Resolution
  • Timetracking
  • Attachment
  • Component
  • Version
  • CustomFieldValue
  • CustomField
  • FieldValue<T>

Was this helpful?

  1. General
  2. API

API for Velocity Context Objects

PreviousAPI for Velocity Context Objects - 1.7NextAddon Pages

Last updated 3 years ago

Was this helpful?

Velocity Context offers many objects for templates. Find the list of variables with explanations here: .

Below is the detailed description of object attributes. You can render the attributes in the templates in the format of $!variable.attribute

User

Attribute Name

Type

Description

String

Internal key of the user it is unique to the users.

String

Loginname of the user

String

Email address of the user

String

Display name of the user

boolean

true if the user account is active in Jira

String

URLs to user avatars in different sizes.

Issue

Attributes

Attribute Name

Type

Description

id

number

Internal ID of the issue

key

String

Unique Issue Key

summary

String

Issue summary

description

Issue Description field with raw value and rendered format

environment

Issue Environment field with raw value and rendered format

project

Project of the issue

issueType

Type of the issue

status

Issue status

resolution

Resolution of the issue

priority

Priority of the issue

timetracking

Timetracking details of the issue

creator

Creator of the issue. The Creater may be different from the Reporter as privileged users may create issues on behalf of others.

reporter

The user set as Reporter in the issue.

assignee

Current assignee.

created

Issue Created date field value with raw value and rendered format.

updated

Issue Updated date field value with raw value and rendered format.

resolutionDate

Issue Resolution date field value with raw value and rendered format.

dueDate

Issue Due Date field value with raw value and rendered format.

customFields

comments

attachments

components

fixVersions

affectsVersions

labels

Methods

Signature

Return type

Parameters

Description

Example

getCustomFieldValue(customFieldKey)

  • customFieldKey: key of the custom field

$!issue.getCustomFieldValue('customfield_10116')

IssueEvent

Attribute Name

Type

Description

eventType

The type of the triggered event.(eg. issue created, issue commented, ...)

issue

The Issue which the event was fired on.

changelog

worklog

comment

timestamp

Date

The time when the issue was triggered

user

The user who triggered the event (added the comment, updated the issue, ...)

Comment

Attribute Name

Type

Description

id

Number

Internal ID of the comment

author

Author of the comment

updateAuthor

Update author of the comment

body

Comment body

created

Creation date

updated

Update date

limitedVisibility

boolean

internalServiceDeskComment

boolean

publicServiceDeskComment

boolean

Changelog

Attribute Name

Type

Description

items

A list of Changelog items

ChangelogItem

Attribute Name

Type

Description

created

field

fieldId

fieldType

from

fromString

to

toString

Worklog

Attribute Name

Type

Description

author

Author of the worklog

comment

The comment added to the worklog

created

The date when the worklog was created

issueId

long

Id of the issue

started

timeSpent

String

timeSpentSeconds

long

visibilityType

String

visibilityValue

String

updateAuthor

updated

EmailCommand

Attribute Name

Type

Description

Template Support

Attribute Name

Type

Description

boolean

Returns true if the given user is an agent on the project, otherwise false.

Project

Attribute Name

Type

Description

IssueType

Status

Priority

Resolution

Timetracking

Attachment

Component

Version

CustomFieldValue

Attribute Name

Type

Description

customField

Reference to the CustomField

renderedValue

String

The value in html as visible in Jira

value

T

Contains the raw value of the field.

Type is the type of declared in Jira. One of

  • Date

  • String

  • User

  • Collection<User>

CustomField

Attribute Name

Type

Description

customId

String

key of the custom field. This is the primary identifier used by Email This Issue. (eg. in macro parameters)

The format is customfield_$id.

itemType

String

type

String

FieldValue<T>

Attribute Name

Type

Description

rawValue

T

Contains the raw value of the field.

Type is the type of declared in Jira. One of

  • Date

  • String

  • User

  • Collection<User>

renderedValue

String

The value in html as visible in Jira

<String>

<String>

<Date>

<Date>

<Date>

<Date>

<>

<>

<>

<>

<>

<>

<String>

Returns a object representing the value of the custom field addressed by the key

<String>

<Date>

<Date>

List<>

<String>

<Date>

<Date>

<Date>

ong

🌪️
FieldValue
FieldValue
Project
IssueType
Status
Resolution
Priority
Timetracking
User
User
User
FieldValue
FieldValue
FieldValue
FieldValue
Collection
CustomFieldValue
Collection
Comment
Collection
Attachment
Collection
Component
Collection
Version
Collection
Version
Collection
CustomFieldValue
API for Velocity Context Objects#CustomFieldValue
API for Velocity Context Objects#Issue
API for Velocity Context Objects#Changelog
API for Velocity Context Objects#Worklog
API for Velocity Context Objects#Comment
API for Velocity Context Objects#User
User
User
FieldValue
FieldValue
FieldValue
API for Velocity Context Objects#ChangelogItem
API for Velocity Context Objects#User
FieldValue
FieldValue
FieldValue
API for Velocity Context Objects#User
FieldValue
API for Velocity Context Objects#CustomField
L
User
Issue
Attributes
Methods
IssueEvent
Comment
Changelog
ChangelogItem
Worklog
EmailCommand
Template Support
Project
IssueType
Status
Priority
Resolution
Timetracking
Attachment
Component
Version
CustomFieldValue
CustomField
FieldValue<T>
Customizable Email Templates#VelocityContextforTemplates