C++

Get JSON Details from the Last MailMan Call

Demonstrates the Chilkat MailMan.GetLastJsonData method, which copies any structured JSON details produced by the immediately preceding method call into a JsonObject. Not every MailMan method produces JSON details, and the method must be called immediately after the call of interest. This example sends an email and then retrieves the JSON details, which include the negotiated TLS version and parameters, the SMTP server's last response and status code, and the result of SMTP authentication.

Tip: JSON parsing code for this result can be generated at Chilkat Tools.

Background: Some Chilkat methods gather structured diagnostic information alongside their normal result — details that are far more useful as data than as a log string. GetLastJsonData exposes that as a JsonObject you can query programmatically, making it easy to record exactly which TLS version was negotiated or which SMTP status code came back. Because it reflects only the most recent call, retrieve it right away: any subsequent MailMan method may replace it.

Chilkat C++ Downloads

Download Chilkat for C++

C++

#include <CkMailMan.h>
#include <CkEmail.h>
#include <CkJsonObject.h>

void ChilkatSample(void)
    {
    bool success = false;

    //  Demonstrates the MailMan.GetLastJsonData method, which copies any structured JSON details
    //  produced by the immediately preceding method call into a JsonObject.  Not every MailMan
    //  method produces JSON details, and it must be called immediately after the method of
    //  interest.

    CkMailMan mailman;

    //  Configure the SMTP server connection.
    mailman.put_SmtpHost("smtp.example.com");
    mailman.put_SmtpPort(465);
    mailman.put_SmtpSsl(true);
    mailman.put_SmtpUsername("user@example.com");
    mailman.put_SmtpPassword("myPassword");

    //  Send an email.
    CkEmail email;
    email.put_Subject("Test email");
    email.put_From("alice@example.com");
    email.AddTo("Bob","bob@example.com");
    email.put_Body("Hello!");
    success = mailman.SendEmail(email);
    if (success == false) {
        std::cout << mailman.lastErrorText() << "\r\n";
        return;
    }

    //  Immediately retrieve any JSON details produced by the send.
    CkJsonObject json;
    mailman.GetLastJsonData(json);

    //  Emit non-compact (indented) JSON for readability.
    json.put_EmitCompact(false);
    std::cout << json.emit() << "\r\n";

    //  Sample output:
    //  
    //    {
    //      "tls": {
    //        "params": {
    //          "sniHostname": "mail.chilkat.io",
    //          "allowConnectionOnlyIfServerChooses": "SSL 3.0 or higher"
    //        },
    //        "negotiatedTlsVersion": "TLS 1.3"
    //      },
    //      "smtp": {
    //        "lastResponse": "250 OK id=1wkjeT-00000002yb4-0uve",
    //        "lastStatus": 250
    //      },
    //      "smtpAuth": {
    //        "user": "test@chilkat.io",
    //        "method": "login",
    //        "statusCode": 235,
    //        "success": true
    //      }
    //    }
    //  
    //  JSON parsing code for this result can be generated at Chilkat's online tool:
    //  https://tools.chilkat.io/jsonParse

    //  Note: Explicitly connecting/authenticating is optional.  Chilkat MailMan automatically
    //  connects and authenticates -- using the property settings above -- whenever a server
    //  operation requires it.  Calling the explicit connect/authenticate methods can still be
    //  helpful to determine whether a failure occurs while connecting or while authenticating.
    }