ExamineMailbox Method
Selects specified mailbox on the IMAP4 server
for read-only access.
This method is identical to SelectMailbox
method with only exception that no changes of mailbox state are allowed (adding
or removing messages, setting flags, etc.).
To get available mailboxes list, use RetrieveMailboxes
method.
If mailbox names you're dealing with may contain non-English characters, please read UTF7EncodeMailboxNames topic
to make sure everything's done right.
blnResult = ObjectName.ExamineMailbox(MailboxName) |
Parameters: | ||
MailboxName As String | Name of the mailbox to select | |
Return value As Boolean | True if successful, False if error has occurred. You can check ErrDesc property or log file to get more detailed error information |
Usage example:
' This sample examines "Inbox" mailbox and displays total number of messages there Dim Mailer 'Using visual basic to create object Set Mailer = CreateObject("MailBee.IMAP4") 'Using ASP to create object 'Set Mailer = Server.CreateObject("MailBee.IMAP4") 'In ASP use Response.Write instead of MsgBox Mailer.EnableLogging = True ' Logging helps to discover any problems Mailer.LogFilePath = "C:\Temp\imap4_log.txt" Mailer.LicenseKey = "put your license key here" If Mailer.Connect("mailserver.com", 143, "MyName", "MyPassword") Then If Mailer.ExamineMailbox("Inbox") Then MsgBox Mailer.MessageCount & " messages in Inbox" End If Mailer.Disconnect Else MsgBox Mailer.ErrDesc End If
See Also:
Selected
Property
RetrieveMailboxes Method
SelectMailbox Method
Copyright © 2002-2024, AfterLogic Corporation. All rights reserved.