cPanel API 2 Functions - Email::getabsbrowsedir - Knowledgebase

Description

This function retrieves the absolute path to a mail folder.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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=getabsbrowsedir&account=

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Get the mail directory path for user@example.com.
$get_mail_dir = $cpanel->api2(
    'Email', 'getabsbrowsedir', 
    array(
        'account'          => 'user@example.com', 
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Get the mail directory path for user@example.com.
my $get_mail_dir = $cpliveapi->api2(
    'Email', 'getabsbrowsedir',
    {
        'account'          => 'user@example.com',
    }
);

cPanel Tag System (deprecated)

Warning:

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.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username Email getabsbrowsedir account=user%40example.com

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "getabsbrowsedir",
    "data": [
      {
        "absdir": "/home/cpaneluser/mail/example.com/user"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Email"
  }
}

Note:

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

Parameters

Note:

If you do not use either parameter, the function returns the cPanel account's main mail directory (for example,/home/cpaneluser/mail/ for the cpaneluser account).

Parameter	Type	Description	Possible values	Example
account	string	An email address, to retrieve that email account's directory.	A valid email address on the cPanel account.	user@example.com
dir	string	A mail directory name, to retrieve its absolute path.	A valid directory on the cPanel account.	maildir

Returns

Return	Type	Description	Possible values	Example
absdir	string	The absolute path to the directory.	The absolute path to a directory on the cPanel account.	/home/cpaneluser/mail/example.com/user
reason	string	A reason for failure. Note: This function only returns areason value if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories