DeleteMessages Method


Marks one or more messages in the currently selected mailbox as "deleted".

This method does not really deletes messages, it just sets "deleted" flag for them. To permanently remove messages marked as "deleted", call Expunge or ExpungeAndClose method.

To delete single message, set First and Last parameters to the same message number or UID.

To delete all messages starting from specified message number (not UID), set First parameter to this number and Last one to MessageCount value.


blnResult = ObjectName.DeleteMessages(First, Last, AsUID)  
Parameters:  
First As Long Message number or UID of the first message in deleted range  
Last As String Message number or UID of the last message in deleted range  
AsUID As Boolean If True, First and Last parameters are treated as UIDs. Otherwise, they are treated as message numbers  
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 deletes first message from "Inbox" mailbox

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:\imap4_log.txt"

Mailer.LicenseKey = "put your license key here"
If Mailer.Connect("mailserver.com", 143, "MyName", "MyPassword") Then
  If Mailer.SelectMailbox("Inbox") Then
    If Mailer.DeleteMessages(1, 1, False) Then
      MsgBox "Message deleted successfully"
    End If
  End If
  Mailer.Disconnect
Else
  MsgBox Mailer.ErrDesc
End If

See Also:

MessageCount Property

Expunge Method
ExpungeAndClose Method
SelectMailbox Method


Copyright 2002-2008, AfterLogic Corporation. All rights reserved.