PHP Extension

Fetch Single Email by UID or Sequence Number

Assuming the UID is known, download a single email by UID from an IMAP mail server. PHP Extension

<?php

include("chilkat.php");

$success = false;

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$imap = new CkImap();

// Connect to an IMAP server.
// Use TLS
$imap->put_Ssl(true);
$imap->put_Port(993);
$success = $imap->Connect('imap.example.com');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Login
$success = $imap->Login('***','***');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Select an IMAP mailbox
$success = $imap->SelectMailbox('Inbox');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

$email = new CkEmail();

$uid = 2014;
$isUid = true;

$success = $imap->FetchEmail(false,$uid,$isUid,$email);
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Display the From and Subject
print $email->fromAddress() . "\n";
print $email->subject() . "\n";

// Display the Body property, which is the default body.
// If an email has an HTML body, the Body property contains
// the HTML source.  Otherwise it contains the plain-text
// body.
print '---- EMAIL BODY ----' . "\n";
print $email->body() . "\n";
print '--------------------' . "\n";

// Display the recipients:

for ($j = 0; $j <= $email->get_NumTo() - 1; $j++) {
    print $email->getToName($j) . ', ' . $email->getToAddr($j) . "\n";
}

for ($j = 0; $j <= $email->get_NumCC() - 1; $j++) {
    print $email->getCcName($j) . ', ' . $email->getCcAddr($j) . "\n";
}

// Show the total size of the email, including body and attachments:
print $email->get_Size() . "\n";

// When a full email is downloaded, we would use the
// email.NumAttachments property in conjunction with the
// email.GetMailAttach* methods.
// However, when an email object contains only the header,
// we need to access the attachment info differently:
$numAttach = $imap->GetMailNumAttach($email);
print $numAttach . "\n";

for ($j = 0; $j <= $numAttach - 1; $j++) {
    print $imap->getMailAttachFilename($email,$j) . "\n";
    $attachSize = $imap->GetMailAttachSize($email,$j);
    print '    size = ' . $attachSize . ' bytes' . "\n";
}

print '--' . "\n";

// Disconnect from the IMAP server.
$success = $imap->Disconnect();

?>