Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

PureBasic Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(PureBasic) IMAP Get List of Flags

When a mailbox is selected, the server response includes a list of flags:

The FLAGS response occurs as a result of a SELECT or EXAMINE command. The flag parenthesized list identifies the flags (at a minimum, the system-defined flags) that are applicable for this mailbox. Flags other than the system flags can also exist, depending on server implementation.
This example demonstrates how to capture the SELECT (or EXAMINE) response, and parse the list of flags.

Chilkat PureBasic Module Download

Chilkat PureBasic Module

IncludeFile "CkStringTable.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkImap.pb"

Procedure ChilkatExample()

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

    ; This example assumes Chilkat Imap to have been previously unlocked.
    ; See Unlock Imap for sample code.

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

    ; Login
    success = CkImap::ckLogin(imap,"MY-IMAP-LOGIN","MY-IMAP-PASSWORD")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Select an IMAP mailbox
    success = CkImap::ckSelectMailbox(imap,"INBOX")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; The LastResponse property contains the full response of the last command.
    selectResponse.s = CkImap::ckLastResponse(imap)
    Debug selectResponse

    ; For example, on GMail, the SELECT response looks like this:

    ; 	* FLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk)
    ; 	* OK [PERMANENTFLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk \*)] Flags permitted.
    ; 	* OK [UIDVALIDITY 3] UIDs valid.
    ; 	* 46 EXISTS
    ; 	* 0 RECENT
    ; 	* OK [UIDNEXT 4147] Predicted next UID.
    ; 	* OK [HIGHESTMODSEQ 402971]
    ; 	aaac OK [READ-WRITE] INBOX selected. (Success)

    ; The goal of this example is to capture the list of FLAGS.
    ; All IMAP servers will respond with the list of flags in a SPACE separated list enclosed in parentheses.

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

    CkStringBuilder::ckAppend(sbResponse,selectResponse)

    ; Get just the list of flags:
    sbFlagList.i = CkStringBuilder::ckCreate()
    If sbFlagList.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbFlagList,CkStringBuilder::ckGetAfterBetween(sbResponse,"* FLAGS","(",")"))
    Debug CkStringBuilder::ckGetAsString(sbFlagList)

    ; sbFlagList contains this:  
    ; 
    ;     \Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk
    ; 

    ; Make sure no more than one SPACE char in a row exists.
    CkStringBuilder::ckTrimInsideSpaces(sbFlagList)
    ; Modify sbFlagList to one flag per line
    numReplaced.i = CkStringBuilder::ckReplace(sbFlagList," ",Chr(13) + Chr(10))

    ; Load a StringTable with the flag names.
    flagsTable.i = CkStringTable::ckCreate()
    If flagsTable.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringTable::ckAppendFromSb(flagsTable,sbFlagList)

    ; Iterate over the individual flag names:
    i.i = 0
    While i < CkStringTable::ckCount(flagsTable)
        Debug Str(i) + ": " + CkStringTable::ckStringAt(flagsTable,i)
        i = i + 1
    Wend

    ; The output is:
    ; 
    ; 	0: \Answered
    ; 	1: \Flagged
    ; 	2: \Draft
    ; 	3: \Deleted
    ; 	4: \Seen
    ; 	5: $Forwarded
    ; 	6: $NotPhishing
    ; 	7: $Phishing
    ; 	8: $label1
    ; 	9: $label2
    ; 	10: $label3
    ; 	11: $label4
    ; 	12: $label5
    ; 	13: Junk
    ; 	14: NonJunk
    ; 


    CkImap::ckDispose(imap)
    CkStringBuilder::ckDispose(sbResponse)
    CkStringBuilder::ckDispose(sbFlagList)
    CkStringTable::ckDispose(flagsTable)


    ProcedureReturn
EndProcedure

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.