PureBasic

Upload (Append) Email to an IMAP Mailbox and get the UID of the Appended Email

Upload / append an email to an IMAP mailbox and get the UID of the appended email. PureBasic

IncludeFile "CkEmail.pb"
IncludeFile "CkImap.pb"

Procedure ChilkatExample()

    success.i = 0

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

    imap.i = CkImap::ckCreate()
    If imap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Connect to an IMAP server.
    ; Use TLS
    CkImap::setCkSsl(imap, 1)
    CkImap::setCkPort(imap, 993)
    success = CkImap::ckConnect(imap,"imap.example.com")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Login
    success = CkImap::ckLogin(imap,"myLogin","myPassword")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Check the capabilities of the IMAP server.
    cap.s = CkImap::ckCapability(imap)
    Debug "IMAP capabilities: " + cap

    ; If the capabilities string contains the substring "UIDPLUS", then 
    ; the UID of the appended email will be available in the AppendUid property (see below).

    ; For example, the GMail IMAP server has these capabilities (at this current time)
    ; * CAPABILITY IMAP4rev1 UNSELECT IDLE NAMESPACE QUOTA ID XLIST CHILDREN 
    ; X-GM-EXT-1 UIDPLUS COMPRESS=DEFLATE ENABLE MOVE CONDSTORE ESEARCH UTF8=ACCEPT 
    ; APPENDLIMIT=35882577 LIST-EXTENDED LIST-STATUS

    email.i = CkEmail::ckCreate()
    If email.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Load the email from a .eml file.
    success = CkEmail::ckLoadEml(email,"myEmail.eml")
    If success <> 1
        Debug CkEmail::ckLastErrorText(email)
        CkImap::ckDispose(imap)
        CkEmail::ckDispose(email)
        ProcedureReturn
    EndIf

    success = CkImap::ckAppendMail(imap,"Inbox",email)
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkEmail::ckDispose(email)
        ProcedureReturn
    EndIf

    ; If the IMAP server supports the UIDPLUS extension, then the 
    ; imap.AppendUid will contain the UID of the appended email.
    ; Otherwise AppendUid will be 0.
    Debug "UID of appended email: " + Str(CkImap::ckAppendUid(imap))

    ; If the IMAP server does NOT have UIDPLUS, then a program can 
    ; first select the mailbox, get the value of the UidNext property,
    ; and then append.  The appended email SHOULD have a UID equal to 
    ; the UidNext that was obtained just prior to appending (assuming no other
    ; program is simultaneously appending an email to the same mailbox).

    ; Note: It is not required to select a mailbox to append.  The select is only
    ; done for the purpose of obtaining the UIDNEXT value.
    success = CkImap::ckSelectMailbox(imap,"Inbox")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkEmail::ckDispose(email)
        ProcedureReturn
    EndIf

    uidNext.i = CkImap::ckUidNext(imap)

    success = CkImap::ckAppendMail(imap,"Inbox",email)
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkEmail::ckDispose(email)
        ProcedureReturn
    EndIf

    Debug "The UID of the appended email SHOULD be " + Str(uidNext)

    Debug "Email uploaded to Inbox!"

    ; Disconnect from the IMAP server.
    success = CkImap::ckDisconnect(imap)


    CkImap::ckDispose(imap)
    CkEmail::ckDispose(email)


    ProcedureReturn
EndProcedure