on_message_list Event

Fired for every message listed by ListMessageSizes and/or ListMessageUIDs .

Syntax

class SPOPMessageListEventParams(object):
  @property
  def message_number() -> int: ...
  @property
  def message_uid() -> str: ...
  @property
  def message_size() -> int: ...

# In class SPOP:
@property
def on_message_list() -> Callable[[SPOPMessageListEventParams], None]: ...
@on_message_list.setter
def on_message_list(event_hook: Callable[[SPOPMessageListEventParams], None]) -> None: ...

Remarks

When list_message_sizes is called, MessageSize is valid, and MessageUID is always an empty string.

When list_message_ui_ds is called, MessageUID is valid, and MessageSize is 0.