(Tcl) Async Upload (Append) Email to an IMAP Mailbox

Use the AppendMailAsync method call to append an email to an IMAP mailbox.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set imap [new_CkImap]

# Connect to an IMAP server.
# Use TLS
CkImap_put_Ssl $imap 1
CkImap_put_Port $imap 993
set success [CkImap_Connect $imap "MY-IMAP-DOMAIN"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Login
set success [CkImap_Login $imap "MY-IMAP-LOGIN" "MY-IMAP-PASSWORD"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

# Create a simple email with 2 recipients.
set email [new_CkEmail]

CkEmail_put_From $email "support@chilkatsoft.com"
CkEmail_AddTo $email "Chilkat Sales" "sales@chilkatsoft.com"
CkEmail_AddTo $email "Chilkat GMail" "chilkat.support@gmail.com"
CkEmail_put_Body $email "This is a test email."
CkEmail_put_Subject $email "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
set task [CkImap_AppendMailAsync $imap "[Gmail]/Sent Mail" $email]
if {[CkImap_get_LastMethodSuccess $imap] != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkEmail $email
    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...
set success [CkTask_Run $task]
if {$success != 1} then {
    puts [CkTask_lastErrorText $task]
    delete_CkTask $task

    delete_CkImap $imap
    delete_CkEmail $email
    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.

delete_CkImap $imap
delete_CkEmail $email