Xojo Plugin

Send a Raw IMAP Command (Binary)

Demonstrates the Chilkat Imap.RawCommandBd method, which sends raw IMAP command bytes and receives the raw response bytes. The first argument is a BinData holding the command — without an IMAP tag or trailing CRLF, which Chilkat supplies — and the second is a BinData that receives the response.

Background: This is an escape hatch for rare server extensions the API does not otherwise expose. It is intended for commands with a single-line response that do not change Imap object state such as the selected mailbox or message count. For everyday operations, use the dedicated methods, which parse responses and maintain object state for you.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the Imap.RawCommandBd method, which sends raw IMAP command bytes and receives
//  the raw response bytes.  The 1st argument is a BinData containing the command (without a tag
//  or trailing CRLF -- Chilkat supplies both), and the 2nd is a BinData that receives the
//  response.

Dim imap As New Chilkat.Imap

imap.Ssl = True
imap.Port = 993

success = imap.Connect("imap.example.com")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

success = imap.Login("user@example.com","myPassword")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

//  Build the raw command.  Do not include an IMAP tag or a trailing CRLF.
Dim bdCmd As New Chilkat.BinData
success = bdCmd.AppendString("CAPABILITY","utf-8")

Dim bdResp As New Chilkat.BinData
success = imap.RawCommandBd(bdCmd,bdResp)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

//  Interpret the response bytes as a UTF-8 string.
Dim respStr As String
respStr = bdResp.GetString("utf-8")
System.DebugLog(respStr)

success = imap.Disconnect()
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If