Xojo Plugin

Get the Total Size of an IMAP Message

Demonstrates the Chilkat Imap.GetMailSize method, which returns the complete server-reported size of a message in bytes, including attachment data. The only argument is the Email. This example fetches only the headers and prints the full message size.

Background: The server reports each message's total size, so this value is available even when only the headers were downloaded. That lets a client show a size column in a message list, sort by size, or warn the user before downloading an unusually large message — all without fetching the full body first.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the Imap.GetMailSize method, which returns the complete server-reported size
//  of a message in bytes, including attachments.  The only argument is the Email.

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

success = imap.SelectMailbox("Inbox")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

//  Fetch only the message headers.  Attachment bodies are NOT downloaded, but the ckx-imap-*
//  metadata describing the attachments is present, so the attachment info methods still work.
Dim headersOnly As Boolean
headersOnly = True
Dim useUid As Boolean
useUid = False
Dim seqNum As Int32
seqNum = 1
Dim email As New Chilkat.Email
success = imap.FetchEmail(headersOnly,seqNum,useUid,email)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

Dim sizeBytes As Int32
sizeBytes = imap.GetMailSize(email)
System.DebugLog("Total message size: " + Str(sizeBytes) + " bytes")

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