Perl

Get the Total Size of an IMAP Message

Demonstrates the Chilkat Imap.GetMailSize method, which returns the complete server-reported size of a message in bytes, including attachment data. The only argument is the Email. This example fetches only the headers and prints the full message size.

Background: The server reports each message's total size, so this value is available even when only the headers were downloaded. That lets a client show a size column in a message list, sort by size, or warn the user before downloading an unusually large message — all without fetching the full body first.

Chilkat Perl Downloads

Download Chilkat for Perl

Chilkat2 Perl

use strict;
use warnings;
use Chilkat2;

# Demonstrates the Imap.GetMailSize method, which returns the complete server-reported size
# of a message in bytes, including attachments.  The only argument is the Email.

my $imap = Chilkat2::Imap->new;

$imap->Ssl(1);
$imap->Port(993);

my $success = $imap->Connect('imap.example.com');
if (!$success) {
    print $imap->LastErrorText, "\n";
    exit;
}

$success = $imap->Login('user@example.com', 'myPassword');
if (!$success) {
    print $imap->LastErrorText, "\n";
    exit;
}

$success = $imap->SelectMailbox('Inbox');
if (!$success) {
    print $imap->LastErrorText, "\n";
    exit;
}

# Fetch only the message headers.  Attachment bodies are NOT downloaded, but the ckx-imap-*
# metadata describing the attachments is present, so the attachment info methods still work.
my $headersOnly = 1;
my $useUid = 0;
my $seqNum = 1;
my $email = Chilkat2::Email->new;
$success = $imap->FetchEmail($headersOnly, $seqNum, $useUid, $email);
if (!$success) {
    print $imap->LastErrorText, "\n";
    exit;
}

my $sizeBytes = $imap->GetMailSize($email);
print 'Total message size: ', $sizeBytes, " bytes\n";

$success = $imap->Disconnect();
if (!$success) {
    print $imap->LastErrorText, "\n";
    exit;
}