PHP Extension

Upload (Append) Email to an IMAP Mailbox and get the UID of the Appended Email

Upload / append an email to an IMAP mailbox and get the UID of the appended email. PHP Extension

<?php

include("chilkat.php");

$success = false;

// This example assumes 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 != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Login
$success = $imap->Login('myLogin','myPassword');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Check the capabilities of the IMAP server.
$cap = $imap->capability();
print 'IMAP capabilities: ' . $cap . "\n";

// If the capabilities string contains the substring "UIDPLUS", then 
// the UID of the appended email will be available in the AppendUid property (see below).

// For example, the GMail IMAP server has these capabilities (at this current time)
// * CAPABILITY IMAP4rev1 UNSELECT IDLE NAMESPACE QUOTA ID XLIST CHILDREN 
// X-GM-EXT-1 UIDPLUS COMPRESS=DEFLATE ENABLE MOVE CONDSTORE ESEARCH UTF8=ACCEPT 
// APPENDLIMIT=35882577 LIST-EXTENDED LIST-STATUS

$email = new CkEmail();

// Load the email from a .eml file.
$success = $email->LoadEml('myEmail.eml');
if ($success != true) {
    print $email->lastErrorText() . "\n";
    exit;
}

$success = $imap->AppendMail('Inbox',$email);
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// If the IMAP server supports the UIDPLUS extension, then the 
// imap.AppendUid will contain the UID of the appended email.
// Otherwise AppendUid will be 0.
print 'UID of appended email: ' . $imap->get_AppendUid() . "\n";

// If the IMAP server does NOT have UIDPLUS, then a program can 
// first select the mailbox, get the value of the UidNext property,
// and then append.  The appended email SHOULD have a UID equal to 
// the UidNext that was obtained just prior to appending (assuming no other
// program is simultaneously appending an email to the same mailbox).

// Note: It is not required to select a mailbox to append.  The select is only
// done for the purpose of obtaining the UIDNEXT value.
$success = $imap->SelectMailbox('Inbox');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

$uidNext = $imap->get_UidNext();

$success = $imap->AppendMail('Inbox',$email);
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

print 'The UID of the appended email SHOULD be ' . $uidNext . "\n";

print 'Email uploaded to Inbox!' . "\n";

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

?>