updateMailbox

Description

Update mailbox using its id.



Params

Name Type Description
apiKey string API key previously generated.
id integer Id of the mailbox that you want to update.
mailboxName string Name for internal usage.
name string Name that shows on emails sent with this mailbox.
email string Email.

 

Returned data

Type: boolean

Description: Return true if mailbox was updated.

 

Json sample code

<?php

$curl = curl_init('https://your_address/ccm/admin/api/version/2/&type=json');

$postData = array(
    'function' => 'updateMailbox',
    'apiKey' => 'apiKey',
    'id' => 5,
    'mailboxName' => 'Example',
    'name' => 'Company Example',
    'email' => 'user@example.org',
);

curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($postData));
curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$json = curl_exec($curl);
if ($json === false) {
    die('Request failed with error: '. curl_error($curl));
}

$result = json_decode($json);
if ($result->status == 0) {
    die('Bad status returned. Error: '. $result->error);
}

var_dump($result->data);

 

Result of API call

bool(true)
Menu Title