(Excel) Fetch Full Email Given Email Header

When email headers are fetched using UIDs (not sequence numbers), then the resultant email object (containing only the header) will include auto-generated ckx-imap-* header fields to record information about the uid, attachments, etc. The IMAP UID of the email will be available in the "ckx-imap-uid" header. There will also be a "ckx-imap-isUid" header field having the value "YES" or "NO". If the email header was downloaded by UID, then "ckx-imap-isUID" will contain the value "YES" and the value of the "ckx-imap-uid" header field is the IMAP UID. If the "ckx-imap-isUID" header has a value of "NO", then the "ckx-imap-uid" header field represents the sequence number. (Sequence numbers of emails on the server can change over time, depending on whether emails are deleted. UIDs must be used to ensure that the correct full email is downloaded.)

The Chilkat Email object provides a GetImapUid method to return the UID from the ckx-imap-uid header. This can then be used to download the full email using the FetchSingle method. Assuming the UID is known, download a single email by UID from an IMAP mail server.

Download Excel Class Modules Chilkat Excel Class Modules

' This example requires the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim imap As Chilkat.Imap
Set imap = Chilkat.NewImap

' Connect to an IMAP server.
' Use TLS
imap.Ssl = True
imap.Port = 993

success = imap.Connect("imap.someMailServer.com")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

' Login
success = imap.Login("***","***")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If

' Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success <> True) Then
    Debug.Print imap.LastErrorText
    Exit Sub
End If


uid = 2014

isUid = True

' Fetch only the email header
Set emailHeader = imap.FetchSingleHeader(uid,isUid)
If (imap.LastMethodSuccess = True) Then

    ' Now fetch the full email

    uidFromCkxHeader = emailHeader.GetImapUid()
    If (uidFromCkxHeader < 0) Then
        ' Failed. 

        Debug.Print "No ckx-imap-uid header was found."
        Exit Sub
    End If

    Set emailFull = imap.FetchSingle(uidFromCkxHeader,True)
    If (imap.LastMethodSuccess = True) Then

        ' OK, we have the full email, do whatever we want...

    End If

End If

' Disconnect from the IMAP server.
success = imap.Disconnect()