JavaScript

Move IMAP Messages to Another Mailbox

Demonstrates the Chilkat Imap.MoveMessages method, which moves the messages in a MessageSet to another mailbox on the server. The first argument is the MessageSet and the second is the destination folder name. This example searches for newsletter messages and moves them to the Archive mailbox.

Background: A true server-side move (the IMAP MOVE extension) is atomic and efficient: the message never leaves the server, so no download/re-upload is involved. If the server lacks the MOVE capability, the equivalent is copy-then-delete-then-expunge — Chilkat handles that fallback for you, but the destination mailbox must already exist.

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.MoveMessages method, which moves the messages in a MessageSet to
//  another mailbox on the server.  The 1st argument is the MessageSet and the 2nd is the
//  destination folder name.

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;
}

success = imap.SelectMailbox("Inbox");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

//  Find the messages to move (here, messages from a particular sender, by UID).
var msgSet = new CkMessageSet();
success = imap.QueryMbx("FROM \"newsletter@example.com\"",true,msgSet);
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

//  Move them to the "Archive" mailbox.
success = imap.MoveMessages(msgSet,"Archive");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

console.log("Moved " + msgSet.Count + " messages to Archive.");

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