Versions Compared

Version Old Version 6 New Version Current
Changes made by

Denny Miller

Denny Miller

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

API

Notes

message.getBody()

Get body content of email. Not available for preprocessing task.

message.getSubject()

Gets the Subject content of email.

message.getAllHeaders()

Get all headers of a message.

Code Block
message.getAllHeaders()[headerName]; // Case sensitive

To loop through all headers:

Code Block
let allHeaders = message.getAllHeaders();
for (const header in allHeaders) {
    print(header); //To retrieve header name
    print(allHeaders[header]); //To retrieve header value (Case-sensitive)
}

message.getHeader(name)

Get value of a message header

Parameters

  • name the name of the header to get

message.setHeader(key, value)

Set the value of a message header

Parameters

  • key (String) the name of the header to set

  • value (String) the value of the header to set

print(str)

Adds output that is recorded during execution and shown in the processing report.

Parameters

  • str (String) the string to be recorded

setOutcome(outcome, reason)

Set the processing outcome of the script

Parameters

  • outcome (String) the outcome type

  • reason (String) the reason for the outcome

Note: outcome must be written in all capitals. Valid outcomes are (IGNORE, FORWARD, DROP)

resultMap

Field processor and Script Rule only. https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map

Note: resultMap requires Directive field processor support. See https://thepluginpeople.atlassian.net/wiki/spaces/JEMHC/pages/3486842881/Field+Processors#Enabling-a-field-processor-for-use

RegExp

Searches within string values for matching content.https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp

setMatch(true)

This is used to define that the script rule is a match. This will result in that Rule and Project being used to process the email.

Examples

Getting all recipients

Code Block
var combined;
if (message.getHeader('to')!==null) {
 combined = message.getHeader('to');
}
if (message.getHeader('cc')!==null) {
  if (combined!==null) {
    combined=combined.concat(message.getHeader('cc'));
  } else {
    combined=message.getHeader('cc');
  }
}
if (message.getHeader('bcc')!==null) {
  if (combined!==null) {
    combined=combined.concat(message.getHeader('bcc'));
  } else {
    combined=message.getHeader('bcc');
  }
}
combined=combined.toLowerCase();
print("Recipients: "+combined);

Match a keyword in the email body using a regular expression

...