Defining message outcomes

Introduction

This feature 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 five outcomes which can be decided via a script:

• Dropped

  jemhUtils.dropMessage(String reason)

   

• Filtered

  jemhUtils.filterMessage(String reason)

   

• Forwarded

  jemhUtils.forwardMessage(String reason)

   

• Rejected

   

• Dropped (Drop and exit group)

Outcome results

Methods

The historical first implementation to define the outcome was only done in Script Field Processor, this has now been expanded to the other scripted processing locations:

Script Pre Proc Task

since 5.0.5

The Pre-Proc task runs and has quick access to email headers:

Script Field Processor

The Script Field Proc runs after all filtering, its important to ‘claim’ the processing of the mail, as shown here:

Project Mapping Script Rule

since 5.0.5

Open

Example Script

This could be used to reject a message if it contains a certain word within the subject:

The above example produces the following results within the Processing Detail Report:

Open

Email (HTML) received by the sender:

To customise the contents of these emails, please Use Template Sets (Custom Templates).

Further information

The documentation for each of the jemhUtils methods can be found here:

• IJEMHVelocityContextUtils (jemh-api 4.1.0 API)