Cloud Mail 2020 Python Edition

Questions / Feedback?

on_transfer Event

Fired while a document transfers (delivers document).


class Office365TransferEventParams(object):
  def direction() -> int: ...
  def bytes_transferred() -> int: ...
  def percent_done() -> int: ...
  def text() -> bytes: ...

# In class Office365:
def on_transfer() -> Callable[[Office365TransferEventParams], None]: ...
def on_transfer(event_hook: Callable[[Office365TransferEventParams], None]) -> None: ...


The Text parameter contains the portion of the document text being received. It is empty if data is being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

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

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.

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