Perl

Fetch a Set of POP3 Messages by UIDL

Demonstrates the Chilkat MailMan.FetchUidlSet method, which retrieves the messages whose UIDLs are listed in a StringTable and appends them to an EmailBundle. The arguments are the UIDL StringTable, headersOnly, numBodyLines, and the EmailBundle. This example fetches two specific messages by UIDL.

Background: This is the efficient way to download a selected subset of a mailbox in one call — exactly the pattern for an incremental client: list the mailbox UIDLs, compare against the ones you've already stored, and fetch only the new UIDLs as a set. It avoids re-downloading messages you already have while still pulling everything new in a single operation.

Chilkat Perl Downloads

Download Chilkat for Perl

Perl

use chilkat();

$success = 0;

#  Demonstrates the MailMan.FetchUidlSet method, which retrieves the messages whose UIDLs are
#  listed in a StringTable and appends them to an EmailBundle.  The arguments are the UIDL
#  StringTable, headersOnly, numBodyLines, and the EmailBundle.  The messages remain on the
#  server.

$mailman = chilkat::CkMailMan->new();

#  Configure the POP3 server connection.
$mailman->put_MailHost("pop.example.com");
$mailman->put_MailPort(995);
$mailman->put_PopSsl(1);
$mailman->put_PopUsername('user@example.com');
$mailman->put_PopPassword("myPassword");

#  Build the set of UIDLs to fetch.
$uidls = chilkat::CkStringTable->new();
$uidls->Append("0000000123abcdef");
$uidls->Append("0000000124abcdef");

#  Fetch the listed messages (full bodies) into a bundle.
#  headersOnly=0 (fetch the entire message).
#  Note: numBodyLines only applies when headersOnly is 1 (it sets how many lines of the
#  body to include along with the headers).  When headersOnly is 0, the entire message
#  is fetched and numBodyLines is ignored.
$bundle = chilkat::CkEmailBundle->new();

$success = $mailman->FetchUidlSet($uidls,0,0,$bundle);
if ($success == 0) {
    print $mailman->lastErrorText() . "\r\n";
    exit;
}

$n = $bundle->get_MessageCount();
print "Fetched " . $n . " messages." . "\r\n";

$email = chilkat::CkEmail->new();

for ($i = 0; $i <= $n - 1; $i++) {
    $success = $bundle->EmailAt($i,$email);
    print $email->subject() . "\r\n";
}

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