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

Versions Compared

Key

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

Description

Excerpt

This function configures email archiving for a domain.

Include Page
LIB:_cPanelAPI2NoEquivalent
LIB:_cPanelAPI2NoEquivalent

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

Note
titleNote:

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.


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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


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

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.
 
# 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',
    }
);

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 set_archiving_configuration domains=example.com.seconddomain.com incoming=14 mailman=21

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "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"
   }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

Warning
titleWarning:

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
titleNote:

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