Delete a Bundle of POP3 Messages

See more POP3 Examples

Demonstrates the Chilkat MailMan.DeleteBundle method, which deletes POP3 messages using the UIDLs stored in the X-UIDL headers of the Email objects in an EmailBundle. An email without an X-UIDL header is skipped. This example fetches all messages and deletes them.

Background: DeleteBundle is the batch version of DeleteEmail: it marks every message in a downloaded bundle for deletion in one call. A typical "download and clear the mailbox" workflow is to fetch all messages, process them, then delete the whole bundle. Because a bundle can be filtered or built selectively, you can also delete just the subset you no longer need. The deletions commit when the POP3 session ends.

Chilkat C Downloads

Download Chilkat for C

#include <C_CkMailMan.h>
#include <C_CkEmailBundle.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkMailMan mailman;
    HCkEmailBundle bundle;

    success = FALSE;

    //  Demonstrates the MailMan.DeleteBundle method, which deletes POP3 messages using the UIDLs
    //  stored in the X-UIDL headers of the Email objects in an EmailBundle.  An email without an
    //  X-UIDL header is skipped.

    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");

    //  Fetch all messages (headers are enough; each carries an X-UIDL header).
    bundle = CkEmailBundle_Create();

    success = CkMailMan_FetchAll(mailman,TRUE,TRUE,0,bundle);
    if (success == FALSE) {
        printf("%s\n",CkMailMan_lastErrorText(mailman));
        CkMailMan_Dispose(mailman);
        CkEmailBundle_Dispose(bundle);
        return;
    }

    //  Delete every message in the bundle.
    success = CkMailMan_DeleteBundle(mailman,bundle);
    if (success == FALSE) {
        printf("%s\n",CkMailMan_lastErrorText(mailman));
        CkMailMan_Dispose(mailman);
        CkEmailBundle_Dispose(bundle);
        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);
        CkEmailBundle_Dispose(bundle);
        return;
    }

    printf("Deleted %d messages from the POP3 server.\n",CkEmailBundle_getMessageCount(bundle));

    //  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);
    CkEmailBundle_Dispose(bundle);

    }