addMailbox

Description

Add new mailbox.



Params

Name Type Description
apiKey string API key previously generated.
mailboxName string Name for internal usage.
name string Name that shows on emails sent with this mailbox.
email string Email.

 

Returned data

Type: integer

Description: Return an integer with mailbox id.

 

Json sample code

<?php

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

$postData = array(
    'function' => 'addMailbox',
    'apiKey' => 'apiKey',
    '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

int(11)
Menu Title