Child pages
  • cPanel API 2 Functions - Email::getabsbrowsedir

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function retrieves the absolute path to a mail folder.

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledReceiveMailRole
PageWithExcerptLIB:_ServerRoleDisabledAPI
 

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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="user@example.com"

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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', 
    ) 
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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', 
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


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

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


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


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

Note
titleNote:

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).


ParameterTypeDescriptionPossible valuesExample
accountstring

An email address, to retrieve that email account's directory.

A valid email address on the cPanel account.

user@example.com
dirstring

A mail directory name, to retrieve its absolute path.

A valid directory on the cPanel account.

maildir

Returns

ReturnTypeDescriptionPossible valuesExample
absdirstringThe absolute path to the directory.The absolute path to a directory on the cPanel account.
/home/cpaneluser/mail/example.com/user
reasonstring

A reason for failure.

Note
titleNote:

This function only returns a reason value if it failed. 


A string that describes the error.

This is an error message.
resultBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
1