PHP Extension

Async Upload (Append) Email to an IMAP Mailbox

Use the AppendMailAsync method call to append an email to an IMAP mailbox. 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('MY-IMAP-DOMAIN');
if ($success != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

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

// Create a simple email with 2 recipients.
$email = new CkEmail();
$email->put_From('support@chilkatsoft.com');
$email->AddTo('Chilkat Sales','sales@chilkatsoft.com');
$email->AddTo('Chilkat GMail','chilkat.support@gmail.com');
$email->put_Body('This is a test email.');
$email->put_Subject('This is a test email.');

// Imagine we've sent this email via SMTP, and now we want to 
// save the email to our "Sent" mailbox.  On GMail, the mailbox name
// for sent email is "[Gmail]/Sent Mail".

// Call the async version of the AppendMail method to return a task object.
// task is a CkTask
$task = $imap->AppendMailAsync('[Gmail]/Sent Mail',$email);
if ($imap->get_LastMethodSuccess() != true) {
    print $imap->lastErrorText() . "\n";
    exit;
}

// Schedule the task for running on the thread pool.  This changes the task's state
// from Inert to Live.  The task is now running...
$success = $task->Run();
if ($success != true) {
    print $task->lastErrorText() . "\n";

    exit;
}

// -------------------------------------------------------------------------------
// The following is a general note that applies to all programming languages:
// -------------------------------------------------------------------------------
// Your application can keep a reference to the task object and periodically check back later to see if it's finished.
// If your programming language is one that supports callbacks, then the TaskCompleted callback can
// be setup to be called when the task completes.  (See the "Async" category on example-code.com for more information.)
// 
// NOTE: This is very important:  A TaskCompleted callback runs in the background thread.  
// (All callbacks from an async task, such as AbortCheck, PercentDone, ProgressInfo, etc. are in the background thread.) 
// An application that uses TaskCompleted must be very careful.  
// For example, user interface elements (such as labels, text boxes, etc.) may not be directly
// accessible from a background thread, and could crash the application if directly accessed.  Also, attempting to debug
// code running in a background thread from an IDE, especially an older IDE (such as VB6) is likely to crash the IDE.

?>