Delete a Set of POP3 Messages by UIDL

See more POP3 Examples

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 C Downloads

Download Chilkat for C

#include <C_CkMailMan.h>
#include <C_CkStringTable.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkMailMan mailman;
    HCkStringTable uidls;

    success = FALSE;

    //  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.

    mailman = CkMailMan_Create();

    //  Configure the POP3 server connection.
    CkMailMan_putMailHost(mailman,"pop.example.com");
    CkMailMan_putMailPort(mailman,995);
    CkMailMan_putPopSsl(mailman,TRUE);
    CkMailMan_putPopUsername(mailman,"user@example.com");
    CkMailMan_putPopPassword(mailman,"myPassword");

    //  Build the set of UIDLs to delete.
    uidls = CkStringTable_Create();
    CkStringTable_Append(uidls,"0000000123abcdef");
    CkStringTable_Append(uidls,"0000000124abcdef");

    //  Mark the messages for deletion.

    success = CkMailMan_DeleteUidlSet(mailman,uidls);
    if (success == FALSE) {
        printf("%s\n",CkMailMan_lastErrorText(mailman));
        CkMailMan_Dispose(mailman);
        CkStringTable_Dispose(uidls);
        return;
    }

    //  Unless the ImmediateDelete property is set to TRUE, the messages are only marked for
    //  deletion.  End the POP3 session (which sends the QUIT command) to commit the deletions.
    success = CkMailMan_Pop3EndSession(mailman);
    if (success == FALSE) {
        printf("%s\n",CkMailMan_lastErrorText(mailman));
        CkMailMan_Dispose(mailman);
        CkStringTable_Dispose(uidls);
        return;
    }

    printf("Deleted the UIDL set from the POP3 server.\n");

    //  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.


    CkMailMan_Dispose(mailman);
    CkStringTable_Dispose(uidls);

    }