imap_free_ex

Frees an IMAP session descriptor.

int imap_free_ex( IMAP *ppimap );

The imap_free_ex function frees an IMAP session descriptor. You call this function after logging out from the IMAP server.

Return Values

If this function succeeds, it returns LR_PASS. Otherwise, it returns LR_FAIL.

Parameterization

Standard parameterization is not available for this function.

Example

In the following example, the imap_free_ex function frees a session descriptor.

    imap_logon_ex( &imap2, "ImapLogon",
            "URL=imap://johnd:letmein@exchange.abc.com",
            LAST );
    imap_logout_ex(&imap2);
    imap_free_ex(&imap2); // Free the IMAP descriptor