JavaScript

Explicitly Begin a POP3 Session

Demonstrates the Chilkat MailMan.Pop3BeginSession method, which explicitly begins a POP3 session by connecting to the POP3 server and authenticating using the current POP3 property settings. Calling it is optional. This example begins a session, performs a mailbox operation, and ends the session.

Background: Pop3BeginSession combines connecting and authenticating into one call. Chilkat does this automatically when a mailbox operation needs it, so the value of calling it explicitly is control: you open one session, perform several operations against it, and close it with Pop3EndSession — avoiding repeated connect/authenticate round trips and keeping deletion marks within a single, well-defined session.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

//  Demonstrates the MailMan.Pop3BeginSession method, which explicitly begins a POP3 session
//  by connecting to the POP3 server and authenticating using the current POP3 property
//  settings.

var mailman = new CkMailMan();

//  Configure the POP3 server connection.
mailman.MailHost = "pop.example.com";
mailman.MailPort = 995;
mailman.PopSsl = true;
mailman.PopUsername = "user@example.com";
mailman.PopPassword = "myPassword";

//  Explicitly begin the POP3 session (connect + authenticate).

success = mailman.Pop3BeginSession();
if (success == false) {
    console.log(mailman.LastErrorText);
    return true;
}

//  Perform one or more mailbox operations within this single session.
console.log("Mailbox count: " + mailman.GetMailboxCount());

//  End the session when finished.
success = mailman.Pop3EndSession();
if (success == false) {
    console.log(mailman.LastErrorText);
    return true;
}

console.log("POP3 session completed.");