Chilkat Online Tools

C++ / Fatture in Cloud API v2 - API Reference / List emails

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http;
    bool success;

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");
    http.SetRequestHeader("Accept","application/json");

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://api-v2.fattureincloud.it/c/:company_id/emails",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "current_page": "<integer>",
    //   "first_page_url": "<uri>",
    //   "from": "<integer>",
    //   "last_page": "<integer>",
    //   "last_page_url": "<uri>",
    //   "next_page_url": "<uri>",
    //   "path": "<uri>",
    //   "per_page": "<integer>",
    //   "prev_page_url": "<uri>",
    //   "to": "<integer>",
    //   "total": "<integer>",
    //   "data": [
    //     {
    //       "id": "<integer>",
    //       "status": "pending",
    //       "sent_date": "<dateTime>",
    //       "errors_count": "<integer>",
    //       "error_log": "<string>",
    //       "from_email": "<string>",
    //       "from_name": "<string>",
    //       "to_email": "<string>",
    //       "to_name": "<string>",
    //       "subject": "<string>",
    //       "content": "<string>",
    //       "copy_to": "<string>",
    //       "recipient_status": "email_opened",
    //       "recipient_date": "<dateTime>",
    //       "kind": "<string>",
    //       "attachments": [
    //         {
    //           "filename": "<string>",
    //           "url": "<string>"
    //         },
    //         {
    //           "filename": "<string>",
    //           "url": "<string>"
    //         }
    //       ]
    //     },
    //     {
    //       "id": "<integer>",
    //       "status": "sending",
    //       "sent_date": "<dateTime>",
    //       "errors_count": "<integer>",
    //       "error_log": "<string>",
    //       "from_email": "<string>",
    //       "from_name": "<string>",
    //       "to_email": "<string>",
    //       "to_name": "<string>",
    //       "subject": "<string>",
    //       "content": "<string>",
    //       "copy_to": "<string>",
    //       "recipient_status": "document_opened",
    //       "recipient_date": "<dateTime>",
    //       "kind": "<string>",
    //       "attachments": [
    //         {
    //           "filename": "<string>",
    //           "url": "<string>"
    //         },
    //         {
    //           "filename": "<string>",
    //           "url": "<string>"
    //         }
    //       ]
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *id = 0;
    const char *status = 0;
    const char *sent_date = 0;
    const char *errors_count = 0;
    const char *error_log = 0;
    const char *from_email = 0;
    const char *from_name = 0;
    const char *to_email = 0;
    const char *to_name = 0;
    const char *subject = 0;
    const char *content = 0;
    const char *copy_to = 0;
    const char *recipient_status = 0;
    const char *recipient_date = 0;
    const char *kind = 0;
    int j;
    int count_j;
    const char *filename = 0;
    const char *url = 0;

    const char *current_page = jResp.stringOf("current_page");
    const char *first_page_url = jResp.stringOf("first_page_url");
    const char *from = jResp.stringOf("from");
    const char *last_page = jResp.stringOf("last_page");
    const char *last_page_url = jResp.stringOf("last_page_url");
    const char *next_page_url = jResp.stringOf("next_page_url");
    const char *path = jResp.stringOf("path");
    const char *per_page = jResp.stringOf("per_page");
    const char *prev_page_url = jResp.stringOf("prev_page_url");
    const char *v_to = jResp.stringOf("to");
    const char *total = jResp.stringOf("total");
    int i = 0;
    int count_i = jResp.SizeOfArray("data");
    while (i < count_i) {
        jResp.put_I(i);
        id = jResp.stringOf("data[i].id");
        status = jResp.stringOf("data[i].status");
        sent_date = jResp.stringOf("data[i].sent_date");
        errors_count = jResp.stringOf("data[i].errors_count");
        error_log = jResp.stringOf("data[i].error_log");
        from_email = jResp.stringOf("data[i].from_email");
        from_name = jResp.stringOf("data[i].from_name");
        to_email = jResp.stringOf("data[i].to_email");
        to_name = jResp.stringOf("data[i].to_name");
        subject = jResp.stringOf("data[i].subject");
        content = jResp.stringOf("data[i].content");
        copy_to = jResp.stringOf("data[i].copy_to");
        recipient_status = jResp.stringOf("data[i].recipient_status");
        recipient_date = jResp.stringOf("data[i].recipient_date");
        kind = jResp.stringOf("data[i].kind");
        j = 0;
        count_j = jResp.SizeOfArray("data[i].attachments");
        while (j < count_j) {
            jResp.put_J(j);
            filename = jResp.stringOf("data[i].attachments[j].filename");
            url = jResp.stringOf("data[i].attachments[j].url");
            j = j + 1;
        }

        i = i + 1;
    }
    }

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
	-H "Accept: application/json"
https://api-v2.fattureincloud.it/c/:company_id/emails

Postman Collection Item JSON

{
  "name": "List emails",
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": [
        {
          "key": "scope",
          "value": "entity.clients:r entity.clients:a entity.suppliers:r entity.suppliers:a products:r products:a issued_documents.invoices:r issued_documents.credit_notes:r issued_documents.receipts:r issued_documents.orders:r issued_documents.quotes:r issued_documents.proformas:r issued_documents.delivery_notes:r issued_documents.work_reports:r issued_documents.supplier_orders:r issued_documents.self_invoices:r issued_documents.invoices:a issued_documents.credit_notes:a issued_documents.receipts:a issued_documents.orders:a issued_documents.quotes:a issued_documents.proformas:a issued_documents.delivery_notes:a issued_documents.work_reports:a issued_documents.supplier_orders:a issued_documents.self_invoices:a received_documents:r received_documents:a stock:r stock:a receipts:r receipts:a taxes:r taxes:a archive:r archive:a cashbook:r cashbook:a settings:r settings:a situation:r",
          "type": "string"
        },
        {
          "key": "redirect_uri",
          "value": "https://api-v2.fattureincloud.it/oauth/token",
          "type": "string"
        },
        {
          "key": "accessTokenUrl",
          "value": "https://api-v2.fattureincloud.it/oauth/token",
          "type": "string"
        },
        {
          "key": "authUrl",
          "value": "https://api-v2.fattureincloud.it/oauth/authorize",
          "type": "string"
        },
        {
          "key": "grant_type",
          "value": "authorization_code",
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/c/:company_id/emails",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "c",
        ":company_id",
        "emails"
      ],
      "variable": [
        {
          "key": "company_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "List Emails."
  },
  "response": [
    {
      "name": "Example response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Accept",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/c/:company_id/emails",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "c",
            ":company_id",
            "emails"
          ],
          "variable": [
            {
              "key": "company_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"current_page\": \"<integer>\",\n  \"first_page_url\": \"<uri>\",\n  \"from\": \"<integer>\",\n  \"last_page\": \"<integer>\",\n  \"last_page_url\": \"<uri>\",\n  \"next_page_url\": \"<uri>\",\n  \"path\": \"<uri>\",\n  \"per_page\": \"<integer>\",\n  \"prev_page_url\": \"<uri>\",\n  \"to\": \"<integer>\",\n  \"total\": \"<integer>\",\n  \"data\": [\n    {\n      \"id\": \"<integer>\",\n      \"status\": \"pending\",\n      \"sent_date\": \"<dateTime>\",\n      \"errors_count\": \"<integer>\",\n      \"error_log\": \"<string>\",\n      \"from_email\": \"<string>\",\n      \"from_name\": \"<string>\",\n      \"to_email\": \"<string>\",\n      \"to_name\": \"<string>\",\n      \"subject\": \"<string>\",\n      \"content\": \"<string>\",\n      \"copy_to\": \"<string>\",\n      \"recipient_status\": \"email_opened\",\n      \"recipient_date\": \"<dateTime>\",\n      \"kind\": \"<string>\",\n      \"attachments\": [\n        {\n          \"filename\": \"<string>\",\n          \"url\": \"<string>\"\n        },\n        {\n          \"filename\": \"<string>\",\n          \"url\": \"<string>\"\n        }\n      ]\n    },\n    {\n      \"id\": \"<integer>\",\n      \"status\": \"sending\",\n      \"sent_date\": \"<dateTime>\",\n      \"errors_count\": \"<integer>\",\n      \"error_log\": \"<string>\",\n      \"from_email\": \"<string>\",\n      \"from_name\": \"<string>\",\n      \"to_email\": \"<string>\",\n      \"to_name\": \"<string>\",\n      \"subject\": \"<string>\",\n      \"content\": \"<string>\",\n      \"copy_to\": \"<string>\",\n      \"recipient_status\": \"document_opened\",\n      \"recipient_date\": \"<dateTime>\",\n      \"kind\": \"<string>\",\n      \"attachments\": [\n        {\n          \"filename\": \"<string>\",\n          \"url\": \"<string>\"\n        },\n        {\n          \"filename\": \"<string>\",\n          \"url\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}"
    }
  ]
}