on_start_transfer Event

Fired when the message or the part data starts transferring.

Syntax

class IMAPStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class IMAP:
@property
def on_start_transfer() -> Callable[[IMAPStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[IMAPStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event is fired when the message body or the part data starts transferring from the server to the local host. Further progress information is provided by the on_transfer and on_end_transfer events.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 Python Edition - Version 20.0 [Build 8307]