| Status | ||||||
|---|---|---|---|---|---|---|
|
| Table of Contents |
|---|
Introduction
The Script Field Processor allows the outcome of a message's processing to be decided preemptively.
This can be useful when you want messages to fail for reasons that they would not normally.
Methods
There are currently four outcomes which can be decided via a script:
Dropped
Code Block language js jemhUtils.dropMessage(String reason)
Filtered
Code Block language js jemhUtils.filterMessage(String reason)
Forwarded
Code Block language js jemhUtils.forwardMessage(String reason)
Rejected
Code Block language js jemhUtils.rejectMessage(String reason)
Dropped (Drop and exit group)
Code Block language js jemhUtils.dropAndExitGroupMessage(String reason)
Outcome results
Message Outcome | Sender Notified? | Admin Notified? | Read/Deleted? |
|---|---|---|---|
Dropped | No | No | Yes |
Filtered | No | No | No |
Forwarded | No | Yes | Yes |
Rejected | Yes | No | Yes |
Dropped (Drop and exit group) | No | No | Yes |
| Info |
|---|
If HintOgrams are turned off, rejections will be treated as being forwarded. |
Example Script
This could be used to reject a message if it contains a certain word within the subject:
| Code Block | ||
|---|---|---|
| ||
if (subject.contains("reject")) {
jemhUtils.rejectMessage("Because I don't like the word reject!");
} |
The above example produces the following results within the Processing Detail Report:
| Info |
|---|
Enable Auditing by clicking Enable on the Auditing page to see these when running Test Cases and for previously processed mail |
Email (HTML) received by the sender:
To customise the contents of these emails, please /wiki/spaces/JEMH/pages/2850840.
Further information
The documentation for each of the jemhUtils methods can be found here:
http://ppl-docs.s3-website-us-east-1.amazonaws.com/JEMH/2.2.3/com/javahollic/jira/emh/api/IJEMHVelocityContextUtils.html