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

Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

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

my $mailman = Chilkat2::MailMan->new;

# Configure the POP3 server connection.
$mailman->MailHost('pop.example.com');
$mailman->MailPort(995);
$mailman->PopSsl(1);
$mailman->PopUsername('user@example.com');
$mailman->PopPassword('myPassword');

# Build the set of UIDLs to fetch.
my $uidls = Chilkat2::StringTable->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.
my $bundle = Chilkat2::EmailBundle->new;

my $success = $mailman->FetchUidlSet($uidls, 0, 0, $bundle);
if (!$success) {
    print $mailman->LastErrorText, "\n";
    exit;
}

my $n = $bundle->MessageCount;
print 'Fetched ', $n, " messages.\n";

my $email = Chilkat2::Email->new;
for my $i (0 .. $n - 1) {
    $success = $bundle->EmailAt($i, $email);
    print $email->Subject, "\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.