Node.js

Async Methods Returning an Object

See more Async Examples

Demonstrates how to call an asynchronous method that returns an object. This example reads email from a POP3 server using the Async versions of the Chilkat methods. Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

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

    success = false;

    var mailman = new chilkat.MailMan();

    //  Set the POP3 server's hostname
    mailman.MailHost = "pop.example.com";

    //  Set the POP3 login/password and any other requirements..
    mailman.PopUsername = "myLogin";
    mailman.PopPassword = "myPassword";
    mailman.PopSsl = true;
    mailman.MailPort = 995;

    //  Connect to the POP3 server:
    // task: Task
    var task = mailman.Pop3BeginSessionAsync();
    if (mailman.LastMethodSuccess == false) {
        console.log(mailman.LastErrorText);
        return;
    }

    //  Start the background task.
    success = task.Run();
    if (!success) {
        console.log(task.LastErrorText);

        return;
    }

    //  Wait for the POP3 connect task to finish.
    //  The true/false returned by Wait applies to the Wait method call, not the task.
    var maxWaitMs = 30000;
    success = task.Wait(maxWaitMs);
    if (!success || (task.StatusInt !== 7) || (task.TaskSuccess !== true)) {
        if (!success) {
            //  The task.LastErrorText applies to the Wait method call.
            console.log(task.LastErrorText);
        }
        else {
            //  The ResultErrorText applies to the underlying task method call (i.e. the Pop3BeginSession)
            console.log(task.Status);
            console.log(task.ResultErrorText);
        }

        return;
    }

    //  Get the number of messages in the mailbox.
    task = mailman.GetMailboxCountAsync();

    //  To keep the example short, we'll skip handling failures.
    //  The failures would be handled in the same way as shown above.

    success = task.Run();
    success = task.Wait(maxWaitMs);
    var numMessages = task.GetResultInt();

    if (numMessages == 0) {
        return;
    }

    var email = new chilkat.Email();

    var i;
    for (i = 1; i <= numMessages; i++) {

        task = mailman.FetchByMsgnumAsync(i);
        if (mailman.LastMethodSuccess == false) {
            console.log(mailman.LastErrorText);
            return;
        }

        success = task.Run();
        success = task.Wait(maxWaitMs);
        if (!success || (task.StatusInt !== 7) || (task.TaskSuccess !== true)) {
            if (!success) {
                //  The task.LastErrorText applies to the Wait method call.
                console.log(task.LastErrorText);
            }
            else {
                //  The ResultErrorText applies to the underlying task method call (i.e. the FetchByMsgnum)
                console.log(task.Status);
                console.log(task.ResultErrorText);
            }

            return;
        }

        //  Each Chilkat object that can be a return value of an asynchronous task will
        //  have a method named LoadTaskResult.  The object returned in the underlying
        //  asynchronous method call is retrieved by calling LoadTaskResult. 

        //  To say it another way: The application will provide a pre-existing object of
        //  the desired return type (in this case it is an email object).  This object is
        //  loaded by calling LoadTaskResult.  

        success = email.LoadTaskResult(task);

        if (!success) {
            console.log(email.LastErrorText);
            return;
        }
        else {
            console.log(email.From + ": " + email.Subject + "\n");
        }

    }


}

chilkatExample();