JavaScript
JavaScript
Fetch a Range of POP3 Messages
See more POP3 Examples
Demonstrates the Chilkat MailMan.FetchRange method, which retrieves a range of messages from the POP3 mailbox and appends them to an EmailBundle. The arguments are keepOnServer, headersOnly, numBodyLines, a zero-based inclusive startIndex and endIndex, and the EmailBundle. This example fetches the first five messages.
Background: Fetching a range instead of everything is useful for paging through a large mailbox, or resuming after an interruption — download messages 0–99, then 100–199, and so on. Combined with
headersOnly, it lets you build a quick message-list view without pulling full bodies and attachments up front.
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.
var success = false;
// Demonstrates the MailMan.FetchRange method, which retrieves a range of messages from the
// POP3 mailbox and appends them to an EmailBundle. The arguments are keepOnServer,
// headersOnly, numBodyLines, startIndex, endIndex, and the EmailBundle. The indexes are
// zero-based and inclusive.
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";
// Fetch the first 5 messages (indexes 0 through 4), full bodies, leaving them on the server.
// keepOnServer=true, headersOnly=false (fetch the entire message).
// Note: numBodyLines only applies when headersOnly is true (it sets how many lines of the
// body to include along with the headers). When headersOnly is false, the entire message
// is fetched and numBodyLines is ignored.
var bundle = new CkEmailBundle();
success = mailman.FetchRange(true,false,0,0,4,bundle);
if (success == false) {
console.log(mailman.LastErrorText);
return;
}
var n = bundle.MessageCount;
console.log("Fetched " + n + " messages.");
var email = new CkEmail();
var i;
for (i = 0; i <= n - 1; i++) {
success = bundle.EmailAt(i,email);
console.log(email.Subject);
}
// 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.