PowerTCP Mail for .NET
Message Property
See Also  Send comments on this topic.
Dart.PowerTCP.Mail Namespace > ImapProgressEventArgs Class : Message Property




Gets the ImapMessage object representing the current message being transferred.

Syntax

Visual Basic (Declaration) 
Public ReadOnly Property Message As ImapMessage
Visual Basic (Usage)Copy Code
Dim instance As ImapProgressEventArgs
Dim value As ImapMessage
 
value = instance.Message
C# 
public ImapMessage Message {get;}
Managed Extensions for C++ 
public: __property ImapMessage* get_Message();
C++/CLI 
public:
property ImapMessage^ Message {
   ImapMessage^ get();
}

Property Value

Returns the ImapMessage object representing the current message being transferred.

Example

The following example demonstrates displaying progress when getting messages.
Visual BasicCopy Code
Private Sub GetTest()
   ' Login
   Imap1.Login(Server, User, Pass)
   
   ' Get all messages in INBOX, this will cause the Progress event to be raised.
   Imap1.CurrentMailbox.Get()
   
   ' Logout
   Imap1.Logout()
End Sub
    
Private Sub Imap1_Progress(ByVal sender As Object, ByVal e As Dart.PowerTCP.Mail.ImapProgressEventArgs) Handles Imap1.Progress
   ProgressBar.Minimum = 0
   ProgressBar.Maximum = e.Length
   ProgressBar.Value = e.Position
   LblProgress.Text = "Processing message " + e.Message.Id

   If e.Length = e.Position Then
      LblProgress.Text = "Complete"
   End If
End Sub
C#Copy Code
private void GetTest()
{
   // Login
   imap1.Login(Server, User, Pass);
   
   // Get all messages in INBOX, this will cause the Progress event to be raised.
   imap1.CurrentMailbox.Get();
   
   // Logout
   imap1.Logout();
}

private void imap1_Progress(object sender, Dart.PowerTCP.Mail.ImapProgressEventArgs e)
{
   progressBar.Minimum = 0;
   progressBar.Maximum = (int)e.Length;
   progressBar.Value = (int)e.Position;
   lblProgress.Text = "Processing message " + e.Message.Id;

   if(e.Length == e.Position)
      lblProgress.Text = "Complete";
}

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

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