(PureBasic) Transition from Imap.FetchHeaders to Imap.FetchMsgSet

Provides instructions for replacing deprecated FetchHeaders method calls with FetchMsgSet.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkImap.pb"
IncludeFile "CkEmailBundle.pb"
IncludeFile "CkMessageSet.pb"

Procedure ChilkatExample()

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

    ; ...
    ; ...

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

    success.i = CkImap::ckQueryMbx(imap,"FROM joe@example.com",1,mset)
    ; ...
    ; ...

    ; ------------------------------------------------------------------------
    ; The FetchHeaders method is deprecated:

    bundleObj.i = CkImap::ckFetchHeaders(imap,mset)
    If CkImap::ckLastMethodSuccess(imap) = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkMessageSet::ckDispose(mset)
        ProcedureReturn
    EndIf

    ; ...
    ; ...

    CkEmailBundle::ckDispose(bundleObj)

    ; ------------------------------------------------------------------------
    ; Do the equivalent using FetchMsgSet.
    ; Your application creates a new, empty EmailBundle object which is passed 
    ; in the last argument and filled upon success.

    headersOnly.i = 1

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

    success.i = CkImap::ckFetchMsgSet(imap,headersOnly,mset,bundleOut)
    If success = 0
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        CkMessageSet::ckDispose(mset)
        CkEmailBundle::ckDispose(bundleOut)
        ProcedureReturn
    EndIf



    CkImap::ckDispose(imap)
    CkMessageSet::ckDispose(mset)
    CkEmailBundle::ckDispose(bundleOut)


    ProcedureReturn
EndProcedure