| Visual Basic (Declaration) | |
|---|---|
Public Function Clear() As ImapResponse() | |
| Visual Basic (Usage) | Copy Code |
|---|---|
Dim instance As ImapMessageCollection Dim value() As ImapResponse value = instance.Clear() | |
| C# | |
|---|---|
public ImapResponse[] Clear() | |
| Managed Extensions for C++ | |
|---|---|
public: ImapResponse*[]* Clear(); | |
| C++/CLI | |
|---|---|
public: array<ImapResponse^>^ Clear(); | |
Return Value
An array of ImapResponse objects representing the deleted messages.| Exception | Description |
|---|---|
| Dart.PowerTCP.Mail.ProtocolException | Bad IMAP protocol response received from server. |
| System.Net.Sockets.SocketException | The requested address is not valid in its context. |
The following example demonstrates appending mailboxes to the server.
| Visual Basic | Copy Code |
|---|---|
Private Sub MailboxCollectionTest() ' Login Imap1.Login(Server, User, Pass) ' Create a new mailbox. Imap1.Mailboxes.Add("MyNewBox") ' Get the Mailbox in a short variable name to reduce typing. Dim Box As New Mailbox = Imap1.Mailboxes("MyNewBox") ' APPEND some test messages Dim i As Integer For i = 0 To 5 ' Dynamically create a new message Dim Msg As New MessageStream() Msg.To.Add(New MailAddress("me@test.com")) Msg.From = New MailAddress("you@test.com") Msg.Subject = "test # " + i Msg.Text = "Hello, how are you?" ' Append the message Box.Messages.Add(msg) Next ' Refresh the mail box so new messages will be included Box.Refresh() ' Display a list of the message identifiers. Debug.WriteLine(Box.Messages.ToString()) ' Clear all messages Box.Messages.Clear() ' Logout Imap1.Logout() End Sub | |
| C# | Copy Code |
|---|---|
private void MailboxCollectionTest() { // Login imap1.Login(Server, User, Pass); // Create a new mailbox. imap1.Mailboxes.Add("MyNewBox"); // Get the Mailbox in a short variable name to reduce typing. Mailbox box = imap1.Mailboxes["MyNewBox"]; // APPEND some test messages for(int i=0; i < 5; i++) { // Dynamically create a new message MessageStream msg = new MessageStream(); msg.To.Add(new MailAddress("me@test.com")); msg.From = new MailAddress("you@test.com"); msg.Subject = "test # " + i; msg.Text = "Hello, how are you?"; // Append the message box.Messages.Add(msg); } // Refresh the mail box so new messages will be included box.Refresh(); // Display a list of the message identifiers. Debug.WriteLine(box.Messages.ToString()); // Clear all messages box.Messages.Clear(); // Logout imap1.Logout(); } | |
This method clears all messages in the currently selected mailbox (the mailbox represented by Imap.CurrentMailbox). The messages are cleared by first setting their MessageBase.Delete flag to true then sending an "EXPUNGE" command by calling Mailbox.Purge.
Target Platforms: Microsoft .NET Framework 2.0