Unicode C

Get the IMAP UID of an Email

Demonstrates the Chilkat Email.GetImapUid method. When email headers are downloaded from an IMAP server using Chilkat IMAP, a ckx-imap-uid header field is added to the email, and GetImapUid returns its value. This example sets that header directly to illustrate how the method reads it.

Background: IMAP assigns each message in a mailbox a UID — a stable numeric identifier used to fetch, flag, move, or delete that specific message. Chilkat records it in the ckx-imap-uid header so it stays attached to the downloaded Email object. This is the IMAP counterpart to POP3's UIDL (see the Uidl property), letting an application correlate a local message back to its position on the server.

Chilkat Unicode C Downloads

Download Chilkat for Unicode C

Unicode C

#include <C_CkEmailW.h>

void ChilkatSample(void)
    {
    HCkEmailW email;

    //  Demonstrates the GetImapUid method.  When an email is downloaded from an IMAP server
    //  (using Chilkat IMAP), a ckx-imap-uid header field is added, and GetImapUid returns its
    //  value.  Here we set the header directly to show how the method reads it.

    email = CkEmailW_Create();
    CkEmailW_putSubject(email,L"GetImapUid example");

    //  Normally the IMAP download sets this header; we set it here for demonstration.
    CkEmailW_AddHeaderField(email,L"ckx-imap-uid",L"482");

    wprintf(L"IMAP UID = %u\n",CkEmailW_GetImapUid(email));


    CkEmailW_Dispose(email);

    }