Get emails

Get an e-mail full list

Endpoint

Method	URI
POST	https://apiv2.keliweb.it/api/v2/keliweb/get-emails

Request Parameters

Parameter	Type	Description	Required
HTTP headers: Authorization	string	Bearer + the token to access APIs	Required
limitstart	integer	The offset for the returned log data (default: 0)	Optional
limitnum	integer	The number of records to return (default: 25)	Optional
date	date	The date to retrieve emails for.	Optional
subject	string	The subject to retrieve emails for - uses approximate string matching.	Optional

Response Parameters

Parameter	Type	Description
result	string	The result of the operation: success or error
totalresults	integer	The total number of results available
startnumber	integer	The starting number for the returned results
numreturned	integer	The total number of results returned
emails	array	The activity log entries returned

Example Request (PHP Curl)

            

                    $curl = curl_init();
                    
                    curl_setopt_array($curl, array(
                      CURLOPT_URL => "https://apiv2.keliweb.it/api/v2/keliweb/get-emails",
                      CURLOPT_RETURNTRANSFER => true,
                      CURLOPT_ENCODING => "",
                      CURLOPT_MAXREDIRS => 10,
                      CURLOPT_TIMEOUT => 0,
                      CURLOPT_FOLLOWLOCATION => false,
                      CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
                      CURLOPT_CUSTOMREQUEST => "POST",
                      CURLOPT_POSTFIELDS =>
                        http_build_query(
                                array(
                                    'clientid' => '1',
                                    'subject'  => 'elcom'
                                )
                            ),
                      CURLOPT_HTTPHEADER => array(
                        "Content-Type: multipart/form-data",
                        "X-Requested-With: XMLHttpRequest",
                        "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NhMmNlNkNjNhMmU2MmUxIzZDRkODY5MS1mMDMzLTQ1MWMtYjU-3EHc",
                      ),
                    ));
                    
                    $response = curl_exec($curl);
                    $err = curl_error($curl);
                    
                    curl_close($curl);
                    
                    if ($err) {
                      echo "cURL Error #:" . $err;
                    } else {
                      echo $response;
                    }

            
        

Example Request (jQuery AJAX)

            
                    var form = new FormData();
                    form.append("clientid", "1");
                    form.append("subject", "elcom");

                    var settings = {
                        "async": true,
                        "crossDomain": true,
                        "url": "https://apiv2.keliweb.it/api/v2/keliweb/get-emails",
                        "method": "POST",
                        "headers": {
                            "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImNjMDEwYWVlYmUzMjMxMmZlZjBiNzRjYTBhMmNlNDc2MjNjNhMMTA1MzJjODk1In0",
                            "cache-control": "no-cache",
                        },
                        "processData": false,
                        "contentType": false,
                        "mimeType": "multipart/form-data",
                        "data": form
                    }

                    $.ajax(settings).done(function (response) {
                        console.log(response);
                    });
            
        

Example Response (JSON payload)

            
                {
                    "result"                   : "success",
                    "totalresults"             : "1",
                    "startnumber"              : "0",
                    "numreturned"              : "1",
                    "emails[email][0][id]"     : "1",
                    "emails[email][0][userid]" : "1",
                    "emails[email][0][subject]": "Welcome",
                    "emails[email][0][message]": "*html email content*",
                    "emails[email][0][date]"   : "2016-01-01 13:26:50",
                    "emails[email][0][to]"     : "Test Client ",
                    "emails[email][0][cc]"     : "",
                    "emails[email][0][bcc]"    : ""
                }