ResourcesAPI documentation

API Introduction

Mailkit provides a XML-RPC standard based API for secure remote access and control of some of the functions available in the system.

XML-RPC API accepts connections from permited IPs only. You can see the list of permited IPs and add new ones in integration setup and the API interface is available at https://api.mailkit.eu/rpc.fcgi for the XML-RPC interface and https://api.mailkit.eu/json.fcgi for the JSON interface. Libraries implementing Mailkit's API can be found at https://github.com/mailkit.

Mandatory parameters of all API calls

client_id - User ID can be found in your Mailkit account under menu Profile / Integration / API settings.
client_md5 - MD5 hash can be found in your Mailkit account under menu Profile / Integration / API settings.

System returns numbers of type integer as <i4> or <i8> depending on the value.
<i4>: numbers >= -2147483648 and numbers <= 2147483647 
<i8>: numbers < -2147483648 and numbers > 2147483647

Maximum single request size is 128 MB.

Unsuccessful call response:

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <string>Unauthorized</string>
            </value>
        </param>
    </params>
</methodResponse>

JSON

{  
   "error_status":1,
   "error":"Unauthorized"
}

Failure reason

Unauthorized - invalid client ID or MD5 has been used

XML

<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
    <params>
        <param>
            <value>
                <string>Disallowed IP xx.yyy.x.zz</string>
            </value>
        </param>
    </params>
</methodResponse>

JSON

{
   "error_status":1,
   "error":"Disallowed IP aaa.bbb.ccc.ddd"
}

Failure reason

Disallowed IP

The call has ben initiated from an IP address that is not on the list of permited IPs. Add all the IPs you will be using to initiate API call to the list in your account under menu Profile / Integration / API settings.

Additional error codes

JSON interface returns an error_status with a code in the response message. Any other value of the error code other than 0 is an error.