(Visual FoxPro) 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.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loImap
LOCAL lnSuccess
LOCAL loEmailHeader
LOCAL loEmailFull
LOCAL lnUid
LOCAL lnIsUid
LOCAL lnUidFromCkxHeader

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Imap')
loImap = CreateObject('Chilkat.Imap')

* Connect to an IMAP server.
* Use TLS
loImap.Ssl = 1
loImap.Port = 993
lnSuccess = loImap.Connect("imap.someMailServer.com")
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* Login
lnSuccess = loImap.Login("***","***")
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

* Select an IMAP mailbox
lnSuccess = loImap.SelectMailbox("Inbox")
IF (lnSuccess <> 1) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

lnUid = 2014
lnIsUid = 1

* Fetch only the email header
loEmailHeader = loImap.FetchSingleHeader(lnUid,lnIsUid)
IF (loImap.LastMethodSuccess = 1) THEN

    * Now fetch the full email
    lnUidFromCkxHeader = loEmailHeader.GetImapUid()
    IF (lnUidFromCkxHeader < 0) THEN
        * Failed. 
        RELEASE loEmailHeader
        ? "No ckx-imap-uid header was found."
        RELEASE loImap
        CANCEL
    ENDIF

    loEmailFull = loImap.FetchSingle(lnUidFromCkxHeader,1)
    IF (loImap.LastMethodSuccess = 1) THEN

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

        RELEASE loEmailFull
    ENDIF

    RELEASE loEmailHeader
ENDIF

* Disconnect from the IMAP server.
lnSuccess = loImap.Disconnect()

RELEASE loImap