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

Description

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

Examples 


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


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":{ 
     "domains":[ 
        { 
           "domain":"example.com"
        },
        { 
           "domain":"www.example.com"
        },
		{
		   "domain":"*.example.com"
		},
        { 
            "domain":"xn--oy2b35ckwhba574atvuzkc.com"
        }
     ]
  },  
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "list_blocked_incoming_email_domains"
  }
}


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

ReturnTypeDescriptionPossible valuesExample
domainsarray of hashes

An array that contains each blocked domain.

This array includes the domain return.

domain

string

The blocked domain.

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

A valid fully qualified domain name (FQDN).

example.com