# cPanel API 2 Modules - Email

Warning:

The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Introduction

The Email module modifies cPanel email account settings.

div
Important:
br
When you enable a non-*Standard Node* server profile, the system disables API calls associated with that profile's disabled roles.

## Available functions

* [cPanel API 2 Functions - `Email::accountname`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-accountname) — This function retrieves an email account's username.
* [cPanel API 2 Functions - `Email::adddomainforward`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-adddomainforward) — This function creates a domain-level email forwarder.
* [cPanel API 2 Functions - `Email::addforward`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-addforward) — This function creates an email forwarder.
* [cPanel API 2 Functions - `Email::addmx`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-addmx) — This function creates an MX record.
* [cPanel API 2 Functions - `Email::addpop`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-addpop) — This function adds an email account.
* [cPanel API 2 Functions - `Email::browseboxes`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-browseboxes) — This function retrieves a list of the mail directory's subdirectories (boxes) and files.
* [cPanel API 2 Functions - `Email::changemx`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-changemx) — This function changes an MX entry's configuration.
* [cPanel API 2 Functions - `Email::checkmaindiscard`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-checkmaindiscard) — This function checks whether the system deletes a domain's unroutable mail.
* [cPanel API 2 Functions - `Email::clearpopcache`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-clearpopcache) — This function rebuilds an email account's cache file.
* [cPanel API 2 Functions - `Email::deletefilter`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-deletefilter) — This function deletes an email filter.
* [cPanel API 2 Functions - `Email::delforward`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-delforward) — This function deletes an email forwarder that forwards mail to another address.
* [cPanel API 2 Functions - `Email::delmx`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-delmx) — This function deletes a mail exchanger.
* [cPanel API 2 Functions - `Email::delpop`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-delpop) — This function deletes an email account.
* [cPanel API 2 Functions - `Email::disablefilter`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-disablefilter) — This function disables a filter.
* [cPanel API 2 Functions - `Email::editquota`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-editquota) — This function modifies an email account's disk quota.
* [cPanel API 2 Functions - `Email::enablefilter`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-enablefilter) — This function enables a filter.
* [cPanel API 2 Functions - `Email::fetchautoresponder`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-fetchautoresponder) — This function retrieves an autoresponder's information.
* [cPanel API 2 Functions - `Email::fetchcharmaps`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-fetchcharmaps) — This function retrieves a list of cPanel-supported character encodings.
* [cPanel API 2 Functions - `Email::filteractions`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-filteractions) — This function is deprecated and does not return useful output.
* [cPanel API 2 Functions - `Email::filterlist`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-filterlist) — This function lists mail filters.
* [cPanel API 2 Functions - `Email::filtername`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-filtername) — This function generates a name for a new email filter.
* [cPanel API 2 Functions - `Email::filterrules`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-filterrules) — This function is deprecated and does not return useful output.
* [cPanel API 2 Functions - `Email::get_archiving_configuration`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-get_archiving_configuration) — This function retrieves the cPanel account's archiving configurations.
* [cPanel API 2 Functions - `Email::get_archiving_default_configuration`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-get_archiving_default_configuration) — This function retrieves the default archiving configurations.
* [cPanel API 2 Functions - `Email::get_archiving_types`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-get_archiving_types) — This function lists the available email archiving types.
* [cPanel API 2 Functions - `Email::get_default_email_quota`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-get_default_email_quota) — This function retrieves the system's default email quota.
* [cPanel API 2 Functions - `Email::get_email_signing`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-get_email_signing) — This function checks whether DomainKeys Identified Mail (DKIM) is enabled.
* [cPanel API 2 Functions - `Email::get_max_email_quota`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-get_max_email_quota) — This function retrieves the system's maximum email quota.
* [cPanel API 2 Functions - `Email::getabsbrowsedir`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-getabsbrowsedir) — This function retrieves the absolute path to a mail folder.
* [cPanel API 2 Functions - `Email::getalwaysaccept`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-getalwaysaccept) — This function checks a domain's mail exchanger type.
* [cPanel API 2 Functions - `Email::getdiskusage`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-getdiskusage) — This function retrieves an email account's current disk usage.
* [cPanel API 2 Functions - `Email::getmxcheck`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-getmxcheck) — This function retrieves a domain's mail exchanger's type.
* [cPanel API 2 Functions - `Email::has_delegated_mailman_lists`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-has_delegated_mailman_lists) — This function checks whether an email account possesses administrative privileges on any mailing lists.
* [cPanel API 2 Functions - `Email::list_system_filter_info`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-list_system_filter_info) — This function retrieves the name of the email account's filter file.
* [cPanel API 2 Functions - `Email::listaliasbackups`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listaliasbackups) — This function retrieves a list of the account's domains that use aliases and custom default addresses.
* [cPanel API 2 Functions - `Email::listautoresponders`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listautoresponders) — This function lists the cPanel account's autoresponders.
* [cPanel API 2 Functions - `Email::listdefaultaddresses`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listdefaultaddresses) — This function retrieves the domain's default address and its rules.
* [cPanel API 2 Functions - `Email::listdomainforwards`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listdomainforwards) — This function retrieves information about a domain-level forwarder.
* [cPanel API 2 Functions - `Email::listfilterbackups`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listfilterbackups) — This function lists domains with domain-level filters.
* [cPanel API 2 Functions - `Email::listfilters`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listfilters) — This function lists data for old-style email filters in the cPanel account's `.filter` file.
* [cPanel API 2 Functions - `Email::listforwards`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listforwards) — This function list a domain's forwarders.
* [cPanel API 2 Functions - `Email::listlists`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listlists) — This function lists the cPanel account or domain's mailing lists.
* [cPanel API 2 Functions - `Email::listmaildomains`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listmaildomains) — This function lists the cPanel account's mail domains.
* [cPanel API 2 Functions - `Email::listmx`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listmx) — This function lists mail exchangers.
* [cPanel API 2 Functions - `Email::listmxs`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listmxs) — This function lists mail exchangers.
* [cPanel API 2 Functions - `Email::listpops`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listpops) — This function lists the cPanel account's email addresses.
* [cPanel API 2 Functions - `Email::listpopssingle`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listpopssingle) — This function lists the cPanel account's email addresses.
* [cPanel API 2 Functions - `Email::listpopswithdisk`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listpopswithdisk) — This function lists a domain's email addresses with quota and disk usage information.
* [cPanel API 2 Functions - `Email::listpopswithimage`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-listpopswithimage) — This function lists the cPanel account's email addresses with mainacct.jpg image links.
* [cPanel API 2 Functions - `Email::loadfilter`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-loadfilter) — This function retrieves an email filter's information.
* [cPanel API 2 Functions - `Email::passwdpop`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-passwdpop) — This function modifies an email account's password.
* [cPanel API 2 Functions - `Email::reorderfilters`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-reorderfilters) — This function modifies email filter order.
* [cPanel API 2 Functions - `Email::set_archiving_configuration`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-set_archiving_configuration) — This function configures email archiving for a domain.
* [cPanel API 2 Functions - `Email::set_archiving_default_configuration`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-set_archiving_default_configuration) — This function sets a default email archiving configuration.
* [cPanel API 2 Functions - `Email::set_email_signing`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-set_email_signing) — This function enables or disables DKIM.
* [cPanel API 2 Functions - `Email::setalwaysaccept`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-setalwaysaccept) — This function modifies a mail exchanger's type.
* [cPanel API 2 Functions - `Email::setdefaultaddress`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-setdefaultaddress) — This function configures the cPanel account's default address's rules for un-routable mail.
* [cPanel API 2 Functions - `Email::setmxcheck`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-setmxcheck) — This function modifies a mail exchanger's type.
* [cPanel API 2 Functions - `Email::storefilter`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-storefilter) — This function creates an email filter.
* [cPanel API 2 Functions - `Email::tracefilter`](/cpanel-api-2/cpanel-api-2-modules-email/cpanel-api-2-functions-email-tracefilter) — This function tests mail filters.