Tcl

Delete a Set of POP3 Messages by UIDL

Demonstrates the Chilkat MailMan.DeleteUidlSet method, which marks the POP3 messages whose UIDLs are listed in a StringTable for deletion. Chilkat processes the UIDL set and sends a DELE command for each located message. This example deletes two messages by UIDL.

Background: When you already know exactly which messages to remove — by their stable UIDLs — DeleteUidlSet deletes them all in one call without first downloading them. It is the efficient counterpart to fetching-then-deleting: for example, after processing messages elsewhere, hand back just their UIDLs to clear them. The deletions are committed when the POP3 session ends (unless ImmediateDelete is set).

Chilkat Tcl Downloads

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

#  Demonstrates the MailMan.DeleteUidlSet method, which marks the POP3 messages whose UIDLs
#  are listed in a StringTable for deletion.  Chilkat sends DELE for each located message.

set mailman [new_CkMailMan]

#  Configure the POP3 server connection.
CkMailMan_put_MailHost $mailman "pop.example.com"
CkMailMan_put_MailPort $mailman 995
CkMailMan_put_PopSsl $mailman 1
CkMailMan_put_PopUsername $mailman "user@example.com"
CkMailMan_put_PopPassword $mailman "myPassword"

#  Build the set of UIDLs to delete.
set uidls [new_CkStringTable]

CkStringTable_Append $uidls "0000000123abcdef"
CkStringTable_Append $uidls "0000000124abcdef"

#  Mark the messages for deletion.

set success [CkMailMan_DeleteUidlSet $mailman $uidls]
if {$success == 0} then {
    puts [CkMailMan_lastErrorText $mailman]
    delete_CkMailMan $mailman
    delete_CkStringTable $uidls
    exit
}

#  Unless the ImmediateDelete property is set to 1, the messages are only marked for
#  deletion.  End the POP3 session (which sends the QUIT command) to commit the deletions.
set success [CkMailMan_Pop3EndSession $mailman]
if {$success == 0} then {
    puts [CkMailMan_lastErrorText $mailman]
    delete_CkMailMan $mailman
    delete_CkStringTable $uidls
    exit
}

puts "Deleted the UIDL set from the POP3 server."

#  Note: Explicitly connecting/authenticating is optional.  Chilkat MailMan automatically
#  connects and authenticates -- using the property settings above -- whenever a server
#  operation requires it.  Calling the explicit connect/authenticate methods can still be
#  helpful to determine whether a failure occurs while connecting or while authenticating.

delete_CkMailMan $mailman
delete_CkStringTable $uidls