Child pages
  • cPanel API 2 Functions - Email::set_archiving_configuration
Skip to end of metadata
Go to start of metadata

Description

This function configures email archiving for a domain.


Warning:

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

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Note:

This feature uses the GMT time zone to name directories, select messages to store in each directory, and timestamp messages. You cannot change this behavior.

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=set_archiving_configuration&domains="example.com%2Cseconddomain.com"&incoming="14"&mailman="21"


Note:

 For more information, read our Calls from the WHM API documentation.

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Configure example.com and seconddomain.com's archiving.
$archiving_config = $cpanel->api2(
    'Email', 'set_archiving_configuration', 
    array(
        'domains'      => 'example.com,seconddomain.com',
        'incoming'     => '14',
        'mailman'      => '21',
    ) 
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Configure example.com and seconddomain.com's archiving.
my $archiving_config = $cpliveapi->api2(
    'Email', 'set_archiving_configuration',
    { 
        'domains'      => 'example.com,seconddomain.com',
        'incoming'     => '14',
        'mailman'      => '21',
    }
);


Note:

For more information, read our Guide to the LiveAPI System.

 cPanel Tag System (deprecated)


Warnings:

  • 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. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.
  • 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 documentation.

 Command Line
cpapi2 --user=username Email set_archiving_configuration domains=example.com.seconddomain.com incoming=14 mailman=21


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
  • If you run CloudLinux™, you must use the full path of the cpapi2 command:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{  
   "cpanelresult":{  
      "apiversion":2,
      "func":"set_archiving_configuration",
      "data":[  
         {  
            "direction":"mailman",
            "domain":"example.com",
            "statusmsg":"Updated archive configuration for "example.com".",
            "retention_period":93,
            "status":1,
            "enabled":1
         }
      ],
      "event":{  
         "result":1
      },
      "module":"Email"
   }
}


Note:

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

Parameters

Warning:

Make certain that you use the correct parameters when you call this function. The function will not return errors if you pass invalid parameters. 

ParameterTypeDescriptionPossible valuesExample
domainsstring

Required

One or more domains.

A comma-separated list of valid domains on the cPanel account.

Note:

In WHM API calls, replace commas with %2C

example.com
incominginteger

The length of time to archive incoming messages.

This parameter's value defaults to 0.

  • A positive integer that represents a number of days. For example, to archive messages for one year, set a value of 365 .
  • 0 — Archive messages indefinitely.
365
outgoinginteger

The length of time to archive outgoing messages.

This parameter's value defaults to 0 .

  • A positive integer that represents a number of days. For example, to archive messages for one year, set a value of 365.
  • 0 — Archive messages indefinitely.
365
mailmaninteger

The length of time to archive mailing list messages.

This parameter's value defaults to 0 .

  • A positive integer that represents a number of days. For example, to archive messages for one year, set a value of 365.
  • 0 — Archive messages indefinitely.
365

Returns

ReturnTypeDescriptionPossible valuesExample
directionstringThe archive type.
  • incoming
  • outgoing
  • mailman
mailman
domainstringThe domain or domains.A valid domain.example.com
statusmsgstringA message of success or a reason for failure.
  • A success message.

  • An error message.

Updated archive configuration for “example.com”.
retention_periodinteger

The length of time to archive mailing list messages.

  • A positive integer that represents a number of days.
  • 0 — Archive messages indefinitely.
93
statusBooleanWhether the function succeeded.
  • 1 — The function succeeded.
  • 0 — The function failed.
1
enabledBooleanWhether archiving is enabled.
  • 1 — Enabled.
  • 0 — Disabled.
1
reasonstring

A reason for failure.

Note:

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