We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

Developer Documentation
Child pages
  • WHM API 1 Functions - get_mailbox_status_list
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI


 cPanel Analytics

participate_in_analytics

 Server Administration

add_configclusterserver

configurebackgroundprocesskiller

configureservice

cors_proxy_get

create_user_session

delete_configclusterserver

enable_monitor_all_enabled_services

get_all_contact_importances

get_api_calls

get_api_pages

get_appconfig_application_list

get_application_contact_event_importance  

get_application_contact_importance

get_available_profiles

get_current_profile

get_linked_server_node

get_password_strength

get_remote_access_hash

get_server_node_status

get_service_config

get_service_config_key

get_tcp4_sockets

get_tcp6_sockets

get_tweaksetting

get_udp4_sockets

get_udp6_sockets

get_update_availability

get_users_links

getdiskusage

gethostname

is_role_enabled

link_server_node_with_api_token

list_configclusterservers

list_linked_server_nodes

list_user_worker_nodes

loadavg

nvget

nvset

personalization_get

personalization_set

purchase_a_license

reboot

remove_in_progress_exim_config_edit

restartservice

restore_config_from_file

restore_config_from_upload

run_cpkeyclt

send_test_posturl

send_test_pushbullet_note

servicestatus

set_application_contact_event_importance

set_application_contact_importance  

set_primary_servername

set_service_config_key

set_service_proxy_backends

set_tweaksetting

sethostname

setminimumpasswordstrengths

start_profile_activation

system_needs_reboot

systemloadavg

unlink_server_node

uapi_cpanel

unset_all_service_proxy_backends

update_configclusterserver

update_contact_email

update_linked_server_node

verify_aim_access

verify_icq_access

verify_oscar_access

verify_posturl_access

verify_pushbullet_access

verify_slack_access

 

Description

This function lists the status of a cPanel's mail account's mailboxes.

Important:

In cPanel & WHM version 76 and later, when you disable the Receive Mail role, the system disables this function.

Examples

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/get_mailbox_status_list?api.version=1&account=user@example.com
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/get_mailbox_status_list?api.version=1&account=user@example.com
 Command Line
whmapi1 get_mailbox_status_list account=user@example.com


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)
{ 
   "metadata":{  
      "command":"get_mailbox_status_list",
      "version":1,
      "result":1,
      "reason":"OK"
   },
   "data":{  
	 "mailboxes":[
       { 
           "guid":"1234560f0c58d158c92a000044f0d230",
           "messages":"0",
           "mailbox":"INBOX.marla_singer@example_com",
           "vsize":"0"
        },
        { 
           "guid":"11234560f0c58d158c92a000044f0d23",
           "messages":"0",
           "mailbox":"INBOX.angel_face@example_com",
           "vsize":"0"
        },
        { 
           "guid":"111234560f0c58d158c92a000044f0d2",
           "messages":"0",
           "mailbox":"INBOX.tyler_durden@example_com",
           "vsize":"0"
        },
        { 
           "guid":"1111234560f0c58d158c92a000044f0d",
           "messages":"0",
           "mailbox":"INBOX.Trash",
           "vsize":"0"
        },
        { 
           "guid":"11111234560f0c58d158c92a000044f0",
           "messages":"0",
           "mailbox":"INBOX.narrator@example_com",
           "vsize":"0"
        },
        { 
           "guid":"111111234560f0c58d158c92a000044f",
           "messages":"0",
           "mailbox":"INBOX",
           "vsize":"0"
        },
        { 
           "guid":"1111111234560f0c58d158c92a000004",
           "messages":"0",
           "mailbox":"INBOX.Sent",
           "vsize":"0"
        },
        { 
           "guid":"11111111234560f0c58d158c92a00000",
           "messages":"0",
           "mailbox":"INBOX.Drafts",
           "vsize":"0"
        },
        { 
           "guid":"111111111234560f0c58d158c92a0000",
           "messages":"0",
           "mailbox":"INBOX.robert_paulsen@example_com",
           "vsize":"0"
        }
     ]
   }
}
 Output (XML)
	<metadata>
		<command>get_mailbox_status_list</command>
		<version>1</version>
		<result>1</result>
		<reason>OK</reason>
	</metadata>
	<data>
		<mailboxes>
			<guid>1234560f0c58d158c92a000044f0d230</guid>
			<messages>0</messages>
			<mailbox>INBOX.marla_singer@example_com</mailbox>
			<vsize>0</vsize>
		</mailboxes>
		<mailboxes>
			<guid>11234560f0c58d158c92a000044f0d23</guid>
			<messages>0</messages>
			<mailbox>INBOX.angel_face@example_com</mailbox>
			<vsize>0</vsize>
		</mailboxes>
		<mailboxes>
			<guid>111234560f0c58d158c92a000044f0d2</guid>
			<messages>0</messages>
			<mailbox>INBOX.tyler_durden@example_com</mailbox>
			<vsize>0</vsize>
		</mailboxes>
		<mailboxes>
			<guid>1111234560f0c58d158c92a000044f0d</guid>
			<messages>0</messages>
			<mailbox>INBOX.Trash</mailbox>
			<vsize>0</vsize>
		</mailboxes>
		<mailboxes>
			<guid>11111234560f0c58d158c92a000044f0</guid>
			<messages>0</messages>
			<mailbox>INBOX.narrator@example_com</mailbox>
			<vsize>0</vsize>
		</mailboxes>
		<mailboxes>
			<guid>111111234560f0c58d158c92a000044f</guid>
			<messages>0</messages>
			<mailbox>INBOX</mailbox>
			<vsize>0</vsize>
		</mailboxes>
		<mailboxes>
			<guid>1111111234560f0c58d158c92a000004</guid>
			<messages>0</messages>
			<mailbox>INBOX.Sent</mailbox>
			<vsize>0</vsize>
		</mailboxes>
		<mailboxes>
			<guid>11111111234560f0c58d158c92a00000</guid>
			<messages>0</messages>
			<mailbox>INBOX.Drafts</mailbox>
			<vsize>0</vsize>
		</mailboxes>
		<mailboxes>
			<guid>111111111234560f0c58d158c92a0000</guid>
			<messages>0</messages>
			<mailbox>INBOX.robert_paulsen@example_com</mailbox>
			<vsize>0</vsize>
		</mailboxes>
	</data>


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The email account's name.

  • A valid email account that exists on the server.

  • The cPanel user's account name.

    Note:

    _mainaccount is an alias that represents the cPanel user's mailbox (For example, _mainaccount@example.com represents the example mailbox).

  • user@example.com
  • example
  • _mainaccount@example.com

Returns

ReturnTypeDescriptionPossible valuesExample
mailboxesarray

An array that contains information about the mailbox's contents.

Note:

The mailbox name is the return's name.

This array contains the guid, mailbox, messages, and vsize returns. 

guid

string

The mailbox GUID.

This value returns in the mailboxes array.

A valid alpha-numeric 32-byte GUID that the account owns.
1234560f0c58d158c92a000044f0d230

mailbox

string
The mailbox name.
 This value returns in the mailboxes array.

A valid mailbox folder on the server that the user owns.

INBOX.marla_singer@example_com

messages

integer

The total number of messages in the mailbox.

The function returns this value in the mailboxes array.

A valid integer.0

vsize

integer

The total virtual size of the mailbox's contents, computed with CRLF line terminators.

The function returns this value in the mailboxes array.

A valid integer that represents the virtual size of the mailbox, in bytes.0

Function information

API Version:

WHM API 1

Available in:

WHM 64+

Methods:

GET, POST

Required Parameters:

account

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions