since 3.3.42
| Table of Contents |
|---|
| Info |
|---|
Please refer to the Pre-Processing Task page for setting up and configuring Pre-Processing Tasks: How To Use Pre-Processing Tasks |
After enabling Script Task, return to the profile configuration page and select the edit (pen) icon for Script Task.
...
Pre-Processing Scope : Headers Only
Pre-processing only currently applies to Headers, not the body content, owing to the encoding complexities therein. If this is of interest, please reach out to support@thepluginpeople.com.
Configuration
The edit icon launches the pre-proc script editor.
...
Evaluates the Header Script against the selected Test Case. The result of the script test will be shown below the existing form.
...
Matching Headers:
| Code Block |
|---|
subject,x-subject |
Script:
| Code Block |
|---|
var subject = headerBeans.get('subject').getOriginalVal();
var hdr = jemhUtils.addPreProcHeader("x-subject", "NEW "+subject);
print('new header: '+hdr.getUpdatedVal());
headerBeans.put("x-subject", hdr); |
...
Affected Headers will show changes and additions:
...
Preview Context
This section is to explain what context keys are in the Script Pre-Processing task. Also explains what they are used for when making a script.
| Note |
|---|
Currently three of the context keys are not working and are showing a console error. The three context key’s that are not working are Body, Subject and Related Issue. |
Key | Class | Description |
|---|---|---|
allAddresses | Array of all addresses in the email | |
baseUrl | Jira application URL. For example | |
bccAddresses | Array of all addresses in Bcc header in the email | |
body | Email content from the body of the email | |
ccAddresses | Array of addresses from the Cc header in the email | |
commentManager | Creates or removes Jira comments in the given Issue | |
context | Map of all context keys and all related context items | |
customFieldManager | Manages Custom fields and their values | |
fromAddress | Sender address of the email | |
groupManager | com.atlassian.jira.security.groups.RequestCachingGroupManager | Manages Atlassian’s groups and it’s members |
headerBeans | Header values from the email for example the Sender address and subject | |
issueLinkService | Creates Issue links between Jira issues | |
issueManager | com.atlassian.jira.issue.managers.RequestCachingIssueManager | Provides a number of methods for managing Jira Issues |
jemhUtils | com.javahollic.jira.emh.service.DefaultJEMHVelocityContextUtils | Provides a range of scripting utils including managed of headers shown on this page |
jemhVersion | The installed version of JEMH | |
log | Allows output into the JEMH log | |
message | The Email being processed | |
projectRoleManager | Manages the project roles of the sender | |
relatedIssue | The Issue that is being commented on (null if creating a new Issue) | |
remoteIssueLinkService | com.atlassian.jira.bc.issue.link.DefaultRemoteIssueLinkService | Creates Remote Issue Links that are used in external for example in a third party helpdesk |
searchService | Provides functionality related to searching in Jira using JQL. For example query string generation, parsing and validation | |
senderUser | The Jira User associated to the From address | |
subject | The subject of the email | |
toAddresses | Array of all addresses in the To header of the email | |
userManager | Manages Jira Users on the instance | |
userPropertyManager | Manages all of the Property sets that are associated with Jira users | |
userSearchService | com.atlassian.jira.bc.user.search.DefaultUserPickerSearchService | Provides search functionality for Jira User e.g. |
watcherManager | Allows watches to be added/removed from the Jira Issue |
Changing Headers
Example Test Case
To test this feature out, create a new Test Case, using the following Test Case Content:
|
| Code Block |
|---|
MIME-Version: 1.0 Received: by 10.223.112.12 with HTTP; Sat, 18 Jun 2011 22:42:26 -0700 (PDT) Date: Sun, 19 Jun 2011 17:42:26 +1200 Message-ID: <BANLkTinB1mfSh+GwOXGNWoL4SyDvOpdBoQ@mail.gmail.com> Subject: This is a starting email template, update as required From: from@from.com To: oldTo@oldTo.com, changeme@thiswontwork.com cc: removeme@cc.com Content-Type: text/plain; charset=UTF-8 some text |
...
| Code Block |
|---|
/*Edit Headers*/
if(headerBeans.get('to') != null){
var toAddress = jemhUtils.getOriginalAddressees(headerBeans.get('to'));
print('To Address Header values:', toAddress);
var firstRecipient = toAddress.get(0);
/*Set Address and Personal values of selected recipient*/
firstRecipient.setPersonal("changed recipient");
firstRecipient.setAddress("changed@changed.com");
var updatedHeader = jemhUtils.updatePreProcHeader(toAddress, headerBeans.get('to'));
print(updatedHeader.getUpdatedVal());
print(updatedHeader.getUpdatedVal());
/*Replace Header with new value here*/
headerBeans.replace("to", updatedHeader);
} |
|
Inserting new addresses into an existing Header
...
| Code Block |
|---|
/*Edit Headers*/
if(headerBeans.get('to') != null){
var toAddress = jemhUtils.getOriginalAddressees(headerBeans.get('to'));
print('To Address Header values:', toAddress);
/*create new address*/
var newAddress = jemhUtils.createInternetAddress('new', 'new@new.com');
/*adding new address to To header*/
toAddress.add(newAddress);
var updatedHeader = jemhUtils.updatePreProcHeader(toAddress, headerBeans.get('to'));
print(updatedHeader.getUpdatedVal());
print(updatedHeader.getUpdatedVal());
/*Replace Header with new value here*/
headerBeans.replace("to", updatedHeader);
} |
|
Adding New Headers
| Note |
|---|
Any new Headers you wish to add must be listed the “Matching Headers” csv, or they will not be processed! |
...
| Code Block |
|---|
/* Adding a header */
var bccHeader = jemhUtils.addPreProcHeader('bcc', 'newBcc@newBcc.com');
if(bccHeader != null){
headerBeans.replace('bcc', bccHeader);
print(headerBeans.get('bcc'));
} |
|
Use Auditing to see the post-change email content
Once the mail is changed you can download both the original mail, and the Edited mail:
API Reference
$jemhUtils == http://ppl-docs.s3-website-us-east-1.amazonaws.com/JEMH/3.3.80/com/javahollic/jira/emh/api/IJEMHVelocityContextUtils.html
$headeBeans == https://docs.oracle.com/javase/8/docs/api/java/util/HashMap.html
preProcHeader class == http://ppl-docs.s3-website-us-east-1.amazonaws.com/JEMH/3.3.80/com/javahollic/jira/emh/api/preproc/PreProcHeaderBean.html
...
Method | Used for | Example | ||
|---|---|---|---|---|
jemhUtils.getOriginalAddressees() | Retrieving To/Cc/Bcc/From/Delivered-To Header Values | Retrieving addresses from a specific header to compare against or edit:
| ||
jemhUtils.updatePreProcHeader() | Updating To/Cc/Bcc/From/Delivered-To Header Values | Updating the Sender From address:
| ||
headerBeans.remove(“cc”) | Removing Headers | Removing unwanted Cc address:
| ||
jemhUtils.createInternetAddress(“nn”) | Creating a new Recipient to add to Header | Inserting a Bcc header:
| ||
aHeaderBean.getOriginalVal() | Non-Recipient Header values | Retrieving the Subject Header:
| ||
aHeaderBean.setUpdatedVal(“nnnn”) | Non-Recipient Header values | Changing the Subject Header:
|
Body Script
...