Description
This function lists the available email archiving types.
Warning:
We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.
Examples
Note:
Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.
Parameters
This function does not accept parameters.
Returns
Return |
Type |
Description |
Possible values |
Example |
outgoing |
string |
A message archiving type. |
Outgoing is the only possible value. |
Outgoing |
incoming |
string |
A message archiving type. |
Incoming is the only possible value. |
Incoming |
mailman |
string |
A message archiving type. |
Mailing Lists is the only possible value. |
Mailing Lists |
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 |