(Xojo Plugin) Imap.GetMailSize vs Email.Size

Shows how to get the total size of an email, as well as the sizes of the attachments. This can be done when either full-emails or headers-only are downloaded.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim imap As New Chilkat.Imap

// Connect to an IMAP server.
// Use TLS
imap.Ssl = True
imap.Port = 993
Dim success As Boolean
success = imap.Connect("imap.someMailServer.com")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Login
success = imap.Login("****","****")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

Dim messageSet As Chilkat.MessageSet
// We can choose to fetch UIDs or sequence numbers.
Dim fetchUids As Boolean
fetchUids = True
// Get the message IDs of all the emails in the mailbox
messageSet = imap.Search("ALL",fetchUids)
If (imap.LastMethodSuccess = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// When downloading headers, each email object contains
// (obviously) the headers, but the body will be missing.
// Also, attachments will not be included.  However, it is
// possible to get information about the attachments
// as well as the complete size of the email.
Dim bundle As Chilkat.EmailBundle
bundle = imap.FetchHeaders(messageSet)
If (imap.LastMethodSuccess = False) Then

    System.DebugLog(imap.LastErrorText)
    Return
End If

// Loop over the email objects and display information
// about each:
Dim i As Int32
i = 0
Dim numEmails As Int32
numEmails = bundle.MessageCount
While i < numEmails
    Dim email As Chilkat.Email
    email = bundle.GetEmail(i)

    // Display the From and Subject
    System.DebugLog(email.From)
    System.DebugLog(email.Subject)

    // Display the recipients:
    Dim j As Int32
    For j = 0 To email.NumTo - 1
        System.DebugLog(email.GetToName(j) + ", " + email.GetToAddr(j))
    Next
    For j = 0 To email.NumCC - 1
        System.DebugLog(email.GetCcName(j) + ", " + email.GetCcAddr(j))
    Next

    // Show the total size of the email, including body and attachments:
    System.DebugLog(Str(email.Size))

    // When a full email is downloaded, we would use the
    // email.NumAttachments property in conjunction with the
    // email.GetMailAttach* methods.
    // However, when an email object contains only the header,
    // we need to access the attachment info differently:
    Dim numAttach As Int32
    numAttach = imap.GetMailNumAttach(email)
    For j = 0 To numAttach - 1
        System.DebugLog(imap.GetMailAttachFilename(email,j))
        Dim attachSize As Int32
        attachSize = imap.GetMailAttachSize(email,j)
        System.DebugLog("    size = " + Str(attachSize) + " bytes")
    Next

    System.DebugLog("--")

    i = i + 1
Wend

// Disconnect from the IMAP server.
success = imap.Disconnect()