on_mailbox_status Event

Reports the mailbox status returned from the server.

Syntax

class IMAPClientMailboxStatusEventParams(object):
  @property
  def name() -> str: ...
  @property
  def total_messages() -> int: ...
  @property
  def recent_messages() -> int: ...
  @property
  def unseen_messages() -> int: ...
  @property
  def next_uid() -> int: ...
  @property
  def uid_validity() -> int: ...

# In class IMAPClient:
@property
def on_mailbox_status() -> Callable[[IMAPClientMailboxStatusEventParams], None]: ...
@on_mailbox_status.setter
def on_mailbox_status(event_hook: Callable[[IMAPClientMailboxStatusEventParams], None]) -> None: ...

Remarks

Subscribe to this event to be notified of mailbox status as returned by the IMAP server.