Catalyst Internet Mail .NET

InternetMail.DeleteMailbox Method (String)

Deletes a mailbox from the server.

[Visual Basic]
Overloads Public Function DeleteMailbox( _
   ByVal mailboxName As String _
) As Boolean
[C#]
public bool DeleteMailbox(
   string mailboxName
);

Parameters

mailboxName
A string which specifies the name of the new mailbox to be deleted.

Return Value

This method returns a boolean value. If the method succeeds, the return value is true. If the method fails, the return value is false. To get extended error information, check the value of the LastError property.

Remarks

The DeleteMailbox method deletes a mailbox from the server. A mailbox cannot be deleted if it contains inferior hierarchical names and has the imapFlagNoSelect attribute. On most systems this is the case when the mailbox name references a directory on the server, and that directory contains other subdirectories or mailboxes. To remove the mailbox, you must first delete any child mailboxes that exist.

If the mailbox that is deleted is the currently selected mailbox, it will be automatically unselected and any messages marked for deletion will be expunged before the mailbox is removed. If the delete operation fails, the client will remain in an unselected state until either the ExamineMailbox or SelectMailbox method is called.

The special mailbox named INBOX cannot be deleted.

See Also

InternetMail Class | SocketTools Namespace | InternetMail.DeleteMailbox Overload List