(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Mailman
oleobject loo_Email
integer li_Success
oleobject loo_Task
integer li_CurPctDone

// 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.
loo_Mailman = create oleobject
// Use "Chilkat_9_5_0.MailMan" for versions of Chilkat < 10.0.0
li_rc = loo_Mailman.ConnectToNewObject("Chilkat.MailMan")
if li_rc < 0 then
    destroy loo_Mailman
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// Set the SMTP server and any required settings.
loo_Mailman.SmtpHost = "smtp.mymailserver.com"
loo_Mailman.SmtpUsername = "myLogin"
loo_Mailman.SmtpPassword = "myPassword"
loo_Mailman.StartTLS = 1

// Create a new email object
loo_Email = create oleobject
// Use "Chilkat_9_5_0.Email" for versions of Chilkat < 10.0.0
li_rc = loo_Email.ConnectToNewObject("Chilkat.Email")

loo_Email.Subject = "This is a test"
loo_Email.Body = "This is a test"
loo_Email.From = "Chilkat Support <support@chilkatsoft.com>"
li_Success = loo_Email.AddTo("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.
loo_Task = loo_Mailman.SendEmailAsync(loo_Email)
if loo_Mailman.LastMethodSuccess = 0 then
    Write-Debug loo_Mailman.LastErrorText
    destroy loo_Mailman
    destroy loo_Email
    return
end if

// Schedule the task for running on the thread pool.  This changes the task's state
// from Inert to Live.
li_Success = loo_Task.Run()
if li_Success <> 1 then
    Write-Debug loo_Task.LastErrorText
    destroy loo_Task
    destroy loo_Mailman
    destroy loo_Email
    return
end if

// 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.
li_CurPctDone = 0
do while loo_Task.Finished <> 1

    if loo_Task.PercentDone <> li_CurPctDone then
        li_CurPctDone = loo_Task.PercentDone
        Write-Debug string(li_CurPctDone) + " percent done"
    end if

    // Sleep 100 ms.
    loo_Task.SleepMs(100)

loop

// 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 loo_Task.StatusInt <> 7 then
    Write-Debug "Task did not complete."
    Write-Debug "task status: " + loo_Task.Status
    destroy loo_Task
    destroy loo_Mailman
    destroy loo_Email
    return
end if

// 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.
li_Success = loo_Task.GetResultBool()
if li_Success <> 1 then
    // The task's ResultErrorText contains what would have been in the LastErrorText property had
    // the SendEmail method been called synchronously.
    Write-Debug loo_Task.ResultErrorText
else
    Write-Debug "Email sent asynchronously."
end if

destroy loo_Task

li_Success = loo_Mailman.CloseSmtpConnection()
if li_Success <> 1 then
    Write-Debug "Connection to SMTP server not closed cleanly."

end if



destroy loo_Mailman
destroy loo_Email