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




Gets any additional text returned with the response code.

Syntax

Visual Basic (Declaration) 
Public Property CodeValue As String
Visual Basic (Usage)Copy Code
Dim instance As ImapResponse
Dim value As String
 
instance.CodeValue = value
 
value = instance.CodeValue
C# 
public string CodeValue {get; set;}
Managed Extensions for C++ 
public: __property string* get_CodeValue();
public: __property void set_CodeValue( 
   string* value
);
C++/CLI 
public:
property String^ CodeValue {
   String^ get();
   void set (    String^ value);
}

Property Value

If a code value was included with the response, this property will contain the string representation of that code value. If no code value was included with the response, this property will contain an empty string.

Example

The following example demonstrates using the LineReceived event to detect UIDVALIDITY codes.
Visual BasicCopy Code
Private Sub DoSomething()
   ' Log in. The Imap.LineReceived event will be raised when data is received
   Imap1.Login(Server, User, Pass)

   ' Send a NOOP
   Imap1.Noop()

   ' Log out
   Imap1.Logout()
End Sub

Private Sub Imap1_LineReceived(ByVal sender As Object, ByVal e As Dart.PowerTCP.Mail.ImapResponseEventArgs) Handles Imap1.LineReceived
   Dim Response As ImapResponse
   ' Iterate through all responses.
   For Each Response In e.Responses
	  ' Check if it contained a UIDVALIDITY response.
      If Response.Code = ImapCode.UidValidity Then
         Debug.WriteLine("UIDVALIDITY is " + Response.CodeValue);
      End IF
   Next
End Sub
C#Copy Code
private void DoSomething()
{
   // Log in. The Imap.LineReceived event will be raised when data is received
   imap1.Login(Server, User, Pass);

   // Send a NOOP
   imap1.Noop();

   // Log out
   imap1.Logout();
}

private void imap1_LineReceived(object sender, Dart.PowerTCP.Mail.ImapResponseEventArgs e)
{
   // Iterate through all responses.
   foreach(ImapResponse response in e.Responses)
   {
      // Check if it contained a UIDVALIDITY response.
      if(response.Code == ImapCode.UidValidity)
         Debug.WriteLine("UIDVALIDITY is " + response.CodeValue);
   }
}

Remarks

This property returns any additional text returned with the response code. This additional text is optional even if a response code is received. Typically, this additional text will contain the "value" for the code specified in the response code.

For example, if the following line was received from the IMAP server,

* OK [UIDVALIDITY 1032904889] UIDs valid

the ImapResponse.CodeValue property would contain "1032904889". This information is not included with all responses from the server.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

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