Xojo Plugin

Expunge Deleted Messages and Close the Mailbox

Demonstrates the Chilkat Imap.ExpungeAndClose method, which permanently removes all messages marked with \Deleted from the selected mailbox and then closes the mailbox. This example marks a message deleted and then expunges-and-closes.

Background: This combines two actions into one call: the permanent removal of \Deleted messages (see Expunge) followed by closing the mailbox (see CloseMailbox), returning the session to the authenticated-but-no-mailbox-selected state while staying connected. It's the natural way to finish working with a mailbox after cleaning it up, before selecting another or logging out.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the Imap.ExpungeAndClose method, which permanently removes all messages
//  marked with \Deleted from the selected mailbox and then closes the mailbox.

Dim imap As New Chilkat.Imap

imap.Ssl = True
imap.Port = 993

success = imap.Connect("imap.example.com")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

success = imap.Login("user@example.com","myPassword")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

success = imap.SelectMailbox("Inbox")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

//  Mark message (sequence number 1) with the \Deleted flag.
success = imap.SetFlag(1,False,"\Deleted",1)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

//  Remove the \Deleted messages and close the mailbox in one step.
success = imap.ExpungeAndClose()
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

System.DebugLog("Expunged and closed the mailbox.")

success = imap.Disconnect()
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If