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




Controls the current idle state of the Imap component

Syntax

Visual Basic (Declaration) 
<BrowsableAttribute(False)>
Public Property Idle As Boolean
Visual Basic (Usage)Copy Code
Dim instance As Imap
Dim value As Boolean
 
instance.Idle = value
 
value = instance.Idle
C# 
[BrowsableAttribute(false)]
public bool Idle {get; set;}
Managed Extensions for C++ 
[BrowsableAttribute(false)]
public: __property bool get_Idle();
public: __property void set_Idle( 
   bool value
);
C++/CLI 
[BrowsableAttribute(false)]
public:
property bool Idle {
   bool get();
   void set (    bool value);
}

Property Value

true if the Imap component is currently in the idle state; false otherwise.

Remarks

RFC 2177 defines an idle state for IMAP, in which the client can send an IDLE command to the server, notifying the server that the client is ready to accept unsolicited updates.

The Imap.Idle property gets or sets the current idle state of the Imap component. When Imap.Idle is set to true, the IDLE command is sent to the server. The Imap component will remain in this state until the server sends an update. This will cause the Imap.Update event to be raised. The Imap component will remain in the idle state until Imap.Idle is set to false or any command is sent from the client.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

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