Visual FoxPro

Fetch the Flags Set on an IMAP Message

Demonstrates the Chilkat Imap.FetchFlags method, which returns the flags currently set on a single message as a space-separated string. The first argument is the message ID and the second (bUid) selects UID vs sequence number. This example fetches and prints the flags for one message identified by UID.

Background: The returned string is the server's current flag list for the message, such as \Seen \Flagged. This is a quick way to check a single message's state — for example, to decide whether it still needs processing — without downloading the message itself. To read the same information from a message you already have as an Email object, use GetMailFlag instead.

Chilkat Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loImap
LOCAL loMsgSet
LOCAL lnUid
LOCAL lcFlags

lnSuccess = 0

*  Demonstrates the Imap.FetchFlags method, which returns the flags currently set on a single
*  message as a space-separated string.  The 1st argument is the message ID and the 2nd (bUid)
*  selects UID vs sequence number.

loImap = CreateObject('Chilkat.Imap')

loImap.Ssl = 1
loImap.Port = 993

lnSuccess = loImap.Connect("imap.example.com")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

lnSuccess = loImap.Login("user@example.com","myPassword")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

lnSuccess = loImap.SelectMailbox("Inbox")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

loMsgSet = CreateObject('Chilkat.MessageSet')
lnSuccess = loImap.QueryMbx("ALL",1,loMsgSet)
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    RELEASE loMsgSet
    CANCEL
ENDIF

IF (loMsgSet.Count > 0) THEN
    lnUid = loMsgSet.GetId(0)
    *  FetchFlags returns a string, so assign it to a string variable and check for success.
    lcFlags = loImap.FetchFlags(lnUid,1)
    IF (loImap.LastMethodSuccess = 0) THEN
        ? loImap.LastErrorText
        RELEASE loImap
        RELEASE loMsgSet
        CANCEL
    ENDIF

    ? "UID " + STR(lnUid) + " flags: " + lcFlags
ENDIF

lnSuccess = loImap.Disconnect()
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    RELEASE loMsgSet
    CANCEL
ENDIF

RELEASE loImap
RELEASE loMsgSet