# cPanel API 2 Functions - Email::browseboxes Warning: The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2. ## Description This function retrieves a list of the mail directory's subdirectories (boxes) and files. br Warning: br We **strongly** recommend that you use the following [UAPI](/cpanel/introduction/) function instead of this function: - ` Email::browse_mailbox ` — This function lists the mail directory's subdirectories (boxes) and files. br div Important: br When you disable the [*Receive Mail* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function. br ## Examples WHM API (JSON) ```undefined syntaxhighlighter-pre https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=Email&cpanel_jsonapi_func=browseboxes&account=user@example.com ``` div Note: br For more information, read our [Calls from the WHM API](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation. br LiveAPI PHP Class ```undefined syntaxhighlighter-pre $cpanel = new CPANEL(); // Connect to cPanel - only do this once. // Get a list of boxes for user@example.com. $get_mail_subdir = $cpanel->api2( 'Email', 'browseboxes', array( 'account' => 'user@example.com', ) ); ``` div Note: br For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system). br LiveAPI Perl Module ```undefined syntaxhighlighter-pre my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once. # Get a list of boxes for user@example.com. my $get_mail_subdir = $cpliveapi->api2( 'Email', 'browseboxes', { 'account' => 'user@example.com', } ); ``` div Note: br For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system). br cPanel Tag System (deprecated) div Warnings: br - cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) system to call the cPanel APIs. Examples are **only** present in order to help developers move from the old cPanel tag system to our [LiveAPI](/guides/guide-to-the-liveapi-system). - cPanel API 2 calls that use cPanel tags vary in code syntax and in their output. - For more information, read our [Deprecated cPanel Tag Usage](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation. br Command Line ```undefined syntaxhighlighter-pre cpapi2 --user=username Email browseboxes account=user%40example.com dir=maildir showdotfiles=0 ``` div Note: br For more information and additional output options, read our [Guide to cPanel API 2](/cpanel-api-2/) documentation or run the `cpapi2 --help` command. br Output (JSON) ```undefined syntaxhighlighter-pre { "cpanelresult": { "apiversion": 2, "func": "browseboxes", "data": [ { "mtime": 1413398866, "isleaf": 0, "file": "archive", "path": "/home/example/mail", "depth": 2, "relpath": "/archive", "ismailbox": 0, "fullpath": "/home/example/mail/archive", "type": "dir" }, { "mtime": 1412787616, "isleaf": 0, "file": "example.tld", "path": "/home/example/mail", "depth": 2, "relpath": "/example.com", "ismailbox": 0, "fullpath": "/home/example/mail/example.com", "type": "dir" } ], "event": { "result": 1 }, "module": "Email" } } ``` div Note: br Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls. br ## Parameters div Note: br If you do **not** use a parameter, the function returns a list of items in the cPanel account's main mail directory. br table colgroup col col col col col thead tr th strong Parameter th strong Type th strong Description th strong Possible values th strong Example tbody tr td code account td em string td p An email address, to limit the function's results. p If you do not include this parameter, the function returns data for all of the cPanel account's email addresses. td p A valid email address on the cPanel account. td code user@example.com tr td code dir td em string td p A mail directory name, to limit results to specific directories. p If you do not include this parameter, the function returns data for all directories. td div p A valid directory on the cPanel account. Note: p If you pass code default or code mail , the function lists information for all mail directories. td code maildir tr td code showdotfiles td em Boolean td p Whether to include hidden files and directories. p This value defaults to code 0 . td ul li code 1 — Include hidden items. li code 0 — Do not include hidden items. td code 0 ## Returns table thead tr th strong Return th strong Type th strong Description th strong Possible values th strong Example tbody tr td code mtime td em string td The item's modification time. td A time in a Unix time format. td code 1413398866 tr td code isleaf td em Boolean td Whether the item is a file or a directory. td ul li code 1 — File. li code 0 — Directory. td code 0 tr td code file td em string td The item's base name. td A valid file or directory name. td code archive tr td code path td em string td The item's directory's path. td The item's directory's absolute path. td code /home/example/mail tr td code depth td em integer td The directory depth of the item's path. td A positive integer. td code 2 tr td code relpath td em string td The item's relative path. td The item's relative path, from the mail directory. td code /archive tr td code ismailbox td em Boolean td Whether the item is a mailbox. td ul li code 1 — Mailbox. li code 0 — Not a mailbox. td code 0 tr td code fullpath td em string td The item's full path. td The item's absolute path. td code /home/example/mail/archive tr td code type td em string td The item type. td ul li code dir — The item is a directory. li code file — The item is a file. td code dir tr td code reason td em string td div p A reason for failure. Note: p This function only returns a code reason value if it failed. td p A string that describes the error. td code This is an error message. tr td code result td em Boolean td p Whether the function succeeded. td ul li code 1 — The function succeeded. li code 0 — The function failed. td code 1