JavaScript

Get the POP3 Mailbox Message Count

Demonstrates the Chilkat MailMan.GetMailboxCount method, which returns the number of emails currently available in the POP3 mailbox, or -1 if an error occurs. It is functionally identical to CheckMail. This example configures the POP3 connection and reads the count.

Background: The message count is the number of messages sitting in the POP3 maildrop — the server-side spool that holds mail until a client downloads (and typically deletes) it. Because POP3's traditional model moves mail off the server, this count is essentially the size of the "inbox to be picked up." Chilkat auto-connects using the configured MailHost, credentials, and SSL settings if no session is open.

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

//  Demonstrates the MailMan.GetMailboxCount method, which returns the number of emails
//  currently available in the POP3 mailbox (or -1 if an error occurs).  It is functionally
//  identical to CheckMail.

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

var count = mailman.GetMailboxCount();
console.log("Mailbox message count: " + count);

//  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.