Xbase++

Delete a POP3 Message via an Email Object

Demonstrates the Chilkat MailMan.DeleteEmail method, which deletes a POP3 message using the UIDL stored in the X-UIDL header of an Email object. The email must contain an X-UIDL header, which it does after being fetched from the server. This example fetches a message and then deletes it.

Background: When Chilkat downloads a POP3 message it records the server UIDL in an X-UIDL header on the Email object. DeleteEmail uses that header to tell the server which message to remove — a natural "process then delete" flow: fetch a message, act on it, then delete it. As always in POP3, the deletion is only committed when the session ends (unless ImmediateDelete is set).

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oMailman
LOCAL oEmail

nSuccess := 0

//  Demonstrates the MailMan.DeleteEmail method, which deletes a POP3 message using the UIDL
//  stored in the X-UIDL header of an Email object.  The email must contain an X-UIDL header
//  (as it does after being fetched from the server).

oMailman := CreateObject("Chilkat.MailMan")

//  Configure the POP3 server connection.
oMailman:MailHost := "pop.example.com"
oMailman:MailPort := 995
oMailman:PopSsl := 1
oMailman:PopUsername := "user@example.com"
oMailman:PopPassword := "myPassword"

//  Fetch a message (headers are enough; the X-UIDL header identifies it on the server).
oEmail := CreateObject("Chilkat.Email")

nSuccess := oMailman:FetchOne(1, 0, 1, oEmail)
IF (nSuccess == 0)
    ? oMailman:LastErrorText
    oMailman:destroy()
    oEmail:destroy()
    RETURN
ENDIF

//  Delete that message using its X-UIDL header.
nSuccess := oMailman:DeleteEmail(oEmail)
IF (nSuccess == 0)
    ? oMailman:LastErrorText
    oMailman:destroy()
    oEmail:destroy()
    RETURN
ENDIF

//  Unless the ImmediateDelete property is set to 1, the message is only marked for
//  deletion.  End the POP3 session (which sends the QUIT command) to commit the deletion.
nSuccess := oMailman:Pop3EndSession()
IF (nSuccess == 0)
    ? oMailman:LastErrorText
    oMailman:destroy()
    oEmail:destroy()
    RETURN
ENDIF

? "Deleted the email 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.

oMailman:destroy()
oEmail:destroy()