on_idle_info Event

Fires whenever responses from the server are received while idling.

Syntax

class PIMAPIdleInfoEventParams(object):
  @property
  def message() -> str: ...
  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class PIMAP:
@property
def on_idle_info() -> Callable[[PIMAPIdleInfoEventParams], None]: ...
@on_idle_info.setter
def on_idle_info(event_hook: Callable[[PIMAPIdleInfoEventParams], None]) -> None: ...

Remarks

This event fires each time a response is received from the server after calling start_idle. This will fire with information from the server intended to update the client. The type of data sent by the server may vary.

Message holds the response received from the server.

Cancel may be set to stop idling from within the event. This is equivalent to calling stop_idle.

Some possible values returned by the server are:

+ idling
* 43 EXISTS
* 1 RECENT