Child pages
  • WHM API 1 Function - list_blocked_incoming_email_countries
Skip to end of metadata
Go to start of metadata

Description

This function lists which countries cannot send email to the server.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/list_blocked_incoming_email_countries?api.version=1
 Command Line
whmapi1 list_blocked_incoming_email_countries


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
  "data":{ 
    "countries":[ 
      { 
        "country_code":"AD"
      },
      {
        "country_code":"AE"
      }
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "list_blocked_incoming_email_countries"
  }
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

ParameterTypeDescriptionPossible valuesExample
countriesarray of hashes

An array that contains each blocked country.


This array includes the country_code return.

country_code

string

The blocked country.

The function returns this value in the countries array of hashes.

A valid ISO 3166-1 alpha-2 code two-letter country code.

Note:

To search which country matches each country code, read the ISO's Full list of Country Codes documentation.

AD