(PureBasic) Send Email Asynchronously using a Task

See more SMTP Examples

Send email asynchronously using the task object. Any Chilkat method (in any class/object) that involves network communications or lengthy processing will have an asynchronous version of the method. The asynchronous method has the same name as the synchronous method, but ends in "Async" and returns a Task object. The Task object can be run asynchronously on Chilkat's background thread pool.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkTask.pb"
IncludeFile "CkEmail.pb"
IncludeFile "CkMailMan.pb"

Procedure ChilkatExample()

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

    ; The mailman object is used for sending and receiving email.
    mailman.i = CkMailMan::ckCreate()
    If mailman.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Set the SMTP server and any required settings.
    CkMailMan::setCkSmtpHost(mailman, "smtp.mymailserver.com")
    CkMailMan::setCkSmtpUsername(mailman, "myLogin")
    CkMailMan::setCkSmtpPassword(mailman, "myPassword")
    CkMailMan::setCkStartTLS(mailman, 1)

    ; Create a new email object
    email.i = CkEmail::ckCreate()
    If email.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkEmail::setCkSubject(email, "This is a test")
    CkEmail::setCkBody(email, "This is a test")
    CkEmail::setCkFrom(email, "Chilkat Support <support@chilkatsoft.com>")
    success.i = CkEmail::ckAddTo(email,"Chilkat Admin","admin@chilkatsoft.com")

    ; Call the async version of the SendEmail method to return a task object.
    ; The task object is loaded, but is in the Inert state -- meaning it is
    ; not yet scheduled to run on Chilkat's background thread pool.
    task.i = CkMailMan::ckSendEmailAsync(mailman,email)
    If CkMailMan::ckLastMethodSuccess(mailman) = 0
        Debug CkMailMan::ckLastErrorText(mailman)
        CkMailMan::ckDispose(mailman)
        CkEmail::ckDispose(email)
        ProcedureReturn
    EndIf

    ; Schedule the task for running on the thread pool.  This changes the task's state
    ; from Inert to Live.
    success = CkTask::ckRun(task)
    If success <> 1
        Debug CkTask::ckLastErrorText(task)
        CkTask::ckDispose(task)

        CkMailMan::ckDispose(mailman)
        CkEmail::ckDispose(email)
        ProcedureReturn
    EndIf

    ; The application is now free to do anything else
    ; while the email is being sent.

    ; For this example, we'll simply sleep and periodically
    ; check to see if the SendEmail if finished.  While checking
    ; however, we'll report on the progress.
    curPctDone.i = 0
    While CkTask::ckFinished(task) <> 1

        If CkTask::ckPercentDone(task) <> curPctDone
            curPctDone = CkTask::ckPercentDone(task)
            Debug Str(curPctDone) + " percent done"
        EndIf

        ; Sleep 100 ms.
        CkTask::ckSleepMs(task,100)

    Wend

    ; A finished task could be one that was canceled, aborted, or truly finished.  

    ; If the task was "canceled", it was canceled prior to actually starting.  This could
    ; happen if the task was canceled while waiting in a thread pool queue to be scheduled by Chilkat's
    ; background thread pool scheduler.  

    ; If the task was "aborted", it indicates that it was canceled while running in a background thread.  
    ; The ResultErrorText will likely indicate that the task was aborted.

    ; If the task "completed", then it ran to completion, but the actual success/failure of the method
    ; is determined by the result obtained via a GetResult* method.  (A "completed" task will
    ; have a StatusInt equal to 7.   If the task finished, but was not completed, then it must've
    ; been aborted or canceled:
    If CkTask::ckStatusInt(task) <> 7
        Debug "Task did not complete."
        Debug "task status: " + CkTask::ckStatus(task)
        CkTask::ckDispose(task)

        CkMailMan::ckDispose(mailman)
        CkEmail::ckDispose(email)
        ProcedureReturn
    EndIf

    ; The SendEmail method returns a boolean.  Therefore, after the task is finished,
    ; we can get the boolean result by calling GetResultBool.  This is the return value had
    ; we called SendEmail synchronously.
    success = CkTask::ckGetResultBool(task)
    If success <> 1
        ; The task's ResultErrorText contains what would have been in the LastErrorText property had
        ; the SendEmail method been called synchronously.
        Debug CkTask::ckResultErrorText(task)
    Else
        Debug "Email sent asynchronously."
    EndIf

    CkTask::ckDispose(task)

    success = CkMailMan::ckCloseSmtpConnection(mailman)
    If success <> 1
        Debug "Connection to SMTP server not closed cleanly."

    EndIf



    CkMailMan::ckDispose(mailman)
    CkEmail::ckDispose(email)


    ProcedureReturn
EndProcedure