JavaScript

Open an IMAP Mailbox Read-Only

Demonstrates the Chilkat Imap.ExamineMailbox method, which opens a mailbox as read-only. Use it instead of SelectMailbox when the application must not change message state, such as the \Seen flag. This example examines the Inbox.

Background: Reading a message can have a side effect: fetching its body normally sets the \Seen flag, marking it as read. ExamineMailbox corresponds to IMAP's EXAMINE command, which opens the mailbox in a read-only mode where no such changes are made — ideal for scanning, indexing, or backup tools that must leave the user's mailbox exactly as they left it.

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 Imap.ExamineMailbox method, which opens a mailbox as read-only.  Use this
//  instead of SelectMailbox when the application must not change message state (such as the
//  \Seen flag).

var imap = new CkImap();

imap.Ssl = true;
imap.Port = 993;

success = imap.Connect("imap.example.com");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

success = imap.Login("user@example.com","myPassword");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

//  Open the Inbox as read-only.
success = imap.ExamineMailbox("Inbox");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

console.log("Inbox opened read-only.");

success = imap.Disconnect();
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}