Knowledgebase

account

string

The email address, for user-level filters.

If you do not use this parameter, the function creates an account-level filter.

A valid email address on the account.

user@example.com

filtername

string

Required

The filter name.

A string.

coffee

 oldfiltername 

string

The name of an existing filter, to rename it.

If you do not use this parameter, the function creates a new filter.

A filter on the account.

pool

action*

string

Required

The filter's action.

Important:

You must increment each action. For example, pass the first action as action1and the second action asaction2.

• deliver — Deliver the message to the dest* address.
• fail — Force a delivery failure.
• finish — Stop processing the message.
• save — Save the message to thedest* file.
• pipe — Pipe the message to thedest* application.

deliver

dest*

string

The destination for filtered mail.

This parameter defaults to an empty string.

Important:

• You must increment each destination. For example, pass the first destination as dest1 and the second destination as dest2.
• This parameter isrequired if the actionvalue is deliver, save, or pipe.
• A file path.
• An application path.
• A valid email address.

 cheesecloth@example.com 

match*

string

Required

The filter's match type.

• If the val* parameter is a string, use a string operator.
• If the val* parameter is an integer, use a numeric operator.

Important:

You must increment each match type. For example, pass the first match type asmatch1 and the second match type as match2.

        String operators:

• is
• matches
• contains
• does not contain
• begins
• does not begin
• ends
• does not end
• does not match

        Numeric operators:

• is above
• is not above
• is below
• is not below

contains

opt*

string

The connection between multiple conditions.

This parameter defaults to and.

Important:

You must increment each connection. For example, pass the first connection asopt1 and the second connection as opt2.

• and
• or

and

part*

string

Required

The email section to query.

Important:

You must increment each section. For example, pass the first section as part1 and the second section as part2.

• $header_from: — Match against the From: section.
• $header_subject: — Match against the Subject: section.
• $header_to: — Match against theTo: section.
• $reply_address: — Match against the Reply To: section.
• $message_body — Match against the message's body.
• $message_headers — Match against the message's headers.
• foranyaddress $h_to:,$h_cc:— Match against all message recipients.

Note:

 Generally, the recipient does not receive the BCCfield in an email's header. For this reason, youcannot use the BCC field in a filter.

• not delivered — Match if the message is not queued for delivery.
• error_message — Match if the incoming message bounced.

$message_body

val*

string

or

 integer 

Required

The value to match.

Important:

You must increment each value. For example, pass the first value as val1 and the second value as val2.

• Any string value.
• A positive integer.

coconut

account

 string 

The filter's email address.

 The function only returns this value if it created a user-level filter. 

 The account input return's value. 

 user@example.com