Actions Defined

The following actions are available from the Execute actions and rules drop-down lists available in the PureMessage Manager's Policy Constructor.

Note: As of PureMessage 5.2.1, some actions allow you to specify Japanese characters. See the version 5.2.1 section of the Release History for details.
Note: Some actions can only be executed if your system has a license for the associated module. If a specific module (Anti-Spam, Anti-Virus or Extended Policy) is required, it is shown next to the action name below.

Accept the message

Deliver the message to its envelope recipients.

Add banner (Extended Policy Module)

Add a custom banner to the body or header of a message. If the message contains both an HTML and a plain text part, the banner is added to both (unless Ignore these content-types is used). If the message contains multiple text parts, the banner will be added to the first one.

Add header

Add a header to the message. Specify the name of the header, then the value the header should contain.

Use template variables to specify the value(s) to display in the message header.

Add recipient(s)

Adds a CC (carbon copy) recipient to the message, as opposed to "Redirect the message" (which replaces the envelope recipients) and "Forward to" (which adds a blind carbon copy recipient).

Archive message to a file (Extended Policy Model)

A copy of the message is stored in "mbox" format (compatible with many mail readers) in the specified directory and filename.

Clean the message of any viruses (Anti-Virus Module)

Tells the virus engine to clean the virus from the message. If cleaning fails, the message is quarantined, and a message is sent to the recipient based on the specified Failure Template File.

Collect attachment statistics in message log (Extended Policy Module)

Writes an entry in the message log that includes:

Copy the message to quarantine

Store a copy of the message in the quarantine. This command does not affect the delivery of the message. If called multiple times, multiple copies of the message are stored in the quarantine. The copy stored in the quarantine incorporates any changes made to the message as a result of actions that have occurred to that point.

Delete header

Delete the specified header.

Deliver immediately for

Allows the message to be exempted from further processing for the specified recipients. The "envelope to" address is compared against the list or individual addresses specified in the Arguments pop-up window. For example, to exempt a user's email from being checked for spam, create a Deliver immediately for action before the spam rule.

The message will be queued for delivery and delivered when the pmx-queue program is run (pmx-queue is configured as a scheduled job).

Discard the message

Tells the mail transfer agent to discard the message.

Drop attachment (Extended Policy Module)

Discard the attachment, but deliver the message. This action can only be used with tests that check message attachment characteristics. If the message has multiple attachments, the attachment associated with the test will be dropped.

Forward to

Forward message (via a blind carbon copy) to the specified addresses. This action writes a copy of the message to the outgoing queue, which is then delivered.

Log the message with key/value pair

Mark the message with a key-value pair. The message will accumulate "marks" as it is processed that are written to the message log when the message stops processing. These marks can be used to generate Policy Mark Hits reports, which show a count of keywords and keys from the message log.

Log the message with keyword

Mark the message with given key. The message will accumulate "marks" as it is processed that are written to the message log when the message stops processing. These marks can be used to generate Policy Mark Hits reports, which show a count of keywords and keys from the message log.

Map recipients

Maps the envelope recipients against the specified address map. The envelope recipients are looked up in the address map; if they match a source address, they are replaced with the destination address defined in the address map.

Note that address maps can be configured with an empty Map To value, which has the result of deleting the message.

Notify

Send a notification email to the sender or recipients of a message. The following fields can be configured for notifications:

Quarantine the message

Copy the message to the quarantine; do not deliver the message to the intended recipient(s).

Redirect the message

Replaces all the envelope recipient addresses with the specified address.

Reject the message

Tells the mail transfer agent to reject the message.

Rename attachment (Extended Policy Module)

Rename an attachment. The replacement string can use the %%ATTACHMENT_NAME%% template variable to provide the original filename in the replacement name (for example, %%ATTACHMENT_NAME%%.warning)

Replace header

Replace the value of the specified header with the specified value. See the Add header action for a list of template variables that can be used for the value. If the header does not exist, this action will add it.

Replace message part (Extended Policy Module)

Replace an attachment, or the whole body of the message, with custom text or a file. If used in the same rule as an attachment test, the matching attachment(s) will be replaced. If it is used outside of this context, the entire body of the message will be replaced.

The following template variables can be used in the file or string.

Set a template variable (Extended Policy Module)

Initialize a template variable with a shell command. This action will execute the shell command and put the output in a template variable that can be used in subsequent tests and actions. Use the %%MESSAGE_FILE%% template in the shell command to determine the filename of a file containing a message.

Stop processing

When you add this action to a rule, it prevents processing of subsequent rules if that rule is hit. If you create a new rule by clicking add rule or Add Alternative, the Stop processing action is added by default.

Tempfail the message

Signal the MTA to return SMTP error code 421 (service not available).

Write an entry to pmx_log

Log a message to the PureMessage log file (as specified by the 'log_to' parameter in the pmx.conf configuration file).

Write test data to message log

This action is used for policy tests. When tests are run, this action writes a marker to the message log, and uses that marker to track the test message's progress through the policy filter. This action must be defined in the policy in order to run policy tests.