Child pages
  • cPanel API 2 Functions - Email::loadfilter
Skip to end of metadata
Go to start of metadata

Description

This function retrieves an email filter's information. For more information about Exim filters, read Exim's documentation.

Warning:

We strongly recommend that you use the following UAPI function instead of this function:

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 WHM API (JSON)
https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=loadfilter&filtername="coffee"


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List information for the "coffee" mail filter.
$filter_info = $cpanel->api2(
    'Email', 'loadfilter', 
    array(
        'filtername'      => 'coffee',
    ) 
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List information for the "coffee" mail filter.
my $filter_info = $cpliveapi->api2(
    'Email', 'loadfilter',
    { 
        'filtername'      => 'coffee',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warnings:

  • In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
  • For more information, read our Deprecated cPanel Tag Usage documentation.

 Command Line
cpapi2 --user=username Email loadfilter filtername=coffee


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "loadfilter",
    "data": [
      {
        "filtername": "coffee",
        "actions": [
          {
            "dest": "/dev/null",
            "number": 1,
            "action": "save"
          }
        ],
        "rules": [
          {
            "number": 1,
            "match": "is",
            "part": "$header_from:",
            "opt": "or",
            "val": "user@example.com"
          }
        ]
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
filternamestring

Required

The filter's name.

A string value.coffee
accountstring

The cPanel account name or email address, to retrieve a user-level filter.

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

  • The cPanel username.
  • A user-level filter's email address.
user

Returns

ReturnTypeDescriptionPossible valuesExample
filternamestringThe filter name.A string value.coffee
actionsarray of hashesAn array of hashes of the filter's actions.

Each hash includes the dest, number, and action returns.

 

dest

string

The destination to which the filter sends mail.

The function returns this value in the actions hash.

  • A file path.
  • An application path.
  • A valid email address.
filteredmsgs@example.com

number

integer

The rule's order in the list.

The function returns this value in the actions hash.

A positive integer that represents the rule's order in the filter.

For example, the filter's first rule returns 1.

1

action

string

The filter's action.

The function returns this value in the actions hash.

  • deliver — The filter sends mail to the dest address.
  • fail — The filter forces a delivery failure.
  • finish — The filter stops message processing.
  • save — The filter saves mail to the dest file.
  • pipe — The filter sends mail to the dest application.
deliver
rulesarray of hashesAn array of hashes of the filter's rules.Each hash includes the number, match, part, opt, and val returns. 

number

integer

The rule's order in the list.

The function returns this value in the rules hash.

A positive integer that represents the rule's order in the filter.

For example, the filter's first rule returns 1.

1

match

string

The filter's match type.

The function returns this value in the rules hash.

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

part

string

The queried email section.

The function returns this value in the rules hash.

  • $header_from: — Matches against the From: section.
  • $header_subject: — Matches against the Subject: section.
  • $header_to: — Matches against the To: section.
  • $reply_address: — Matches against the Reply To: section.
  • $message_body — Matches against the message's body.
  • $message_headers — Matches against the message's headers.
  • foranyaddress $h_to:,$h_cc:,$h_bcc: — Matches against all message recipients.
  • not delivered — Matches if the message is not queued for delivery.
  • error_message — Matches if the incoming message bounced.
$message_body

opt

string

The connection between multiple conditions.

The function returns this value in the rules hash.

  • and — Match both conditions.
  • or — Match either condition.
  • null — Only one condition exists.
and

val

string

The matched value.

The function returns this value in the rules hash.

A string value.coconut
reasonstring

A reason for failure.

Note:

This function only returns a reason value if it failed. 

A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1