on_start_transfer Event

Fired when the message or the part data starts transferring.

Syntax

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

# In class GMail:
@property
def on_start_transfer() -> Callable[[GMailStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[GMailStartTransferEventParams], 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.