on_transfer Event

Fired while the message gets transferred from the MailServer .

Syntax

class SIMAPTransferEventParams(object):
  @property
  def direction() -> int: ...
  @property
  def bytes_transferred() -> int: ...
  @property
  def percent_done() -> int: ...
  @property
  def text() -> str: ...

# In class SIMAP:
@property
def on_transfer() -> Callable[[SIMAPTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[SIMAPTransferEventParams], None]) -> None: ...

Remarks

The on_transfer event is fired for every incoming line when receiving a message or part data from the mail_server

The Text parameter contains the portion of the message or the part data being retrieved.

The BytesTransferred parameter contains the number of bytes transferred since the beginning of the message, including header bytes. At the end of transmission (i.e. when the last on_transfer event is fired), BytesTransferred equals the value of the message_size property.

The on_transfer event is fired for every line of the message. There is no terminating newline at the end of the Text parameter. A faster way to retrieve a message is to assign a value to the local_file property and use the on_transfer event only to check the progress rather than to get the actual data.

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.