PowerTCP Mail for .NET
ImapMessageCollection Class
Members  Example  See Also  Send comments on this topic.
Dart.PowerTCP.Mail Namespace : ImapMessageCollection Class




Contains ImapMessage objects.

Object Model

ImapMessageCollection ClassImapMessage Class

Syntax

Visual Basic (Declaration) 
<DefaultMemberAttribute("Item")>
Public Class ImapMessageCollection 
   Inherits SimpleCollectionBase
Visual Basic (Usage)Copy Code
Dim instance As ImapMessageCollection
C# 
[DefaultMemberAttribute("Item")]
public class ImapMessageCollection : SimpleCollectionBase 
Managed Extensions for C++ 
[DefaultMemberAttribute("Item")]
public __gc class ImapMessageCollection : public SimpleCollectionBase 
C++/CLI 
[DefaultMemberAttribute("Item")]
public ref class ImapMessageCollection : public SimpleCollectionBase 

Example

The following example demonstrates appending mailboxes to the server.
Visual BasicCopy 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();
}

Remarks

The ImapMessageCollection class is used to contain ImapMessage objects which are located in the same mailbox. Since this collection is representing server-side objects, using the methods of this class causes IMAP commands to be sent to the server. For example, ImapMessageCollection.Add causes an "APPEND" command to be sent.

Inheritance Hierarchy

System.Object
   System.Collections.ReadOnlyCollectionBase
      Dart.PowerTCP.Mail.SimpleCollectionBase
         Dart.PowerTCP.Mail.ImapMessageCollection

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

Documentation Version 3.2
© 2010 Dart Communications. All Rights Reserved.