IPWorks S/MIME 2020 Python Edition

Questions / Feedback?

on_transfer Event

Fired while the message text gets transferred to MailServer .

Syntax

class SFileMailerTransferEventParams(object):
  @property
  def direction() -> int: ...
  @property
  def bytes_transferred() -> int: ...
  @property
  def percent_done() -> int: ...

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

Remarks

One or more on_transfer events are fired during message delivery. Messages consist of message_text and an optional attached_file. The BytesTransferred parameter shows the number of bytes sent starting from the beginning of message_text and/or attached_file.

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) 2021 /n software inc. - All rights reserved.
IPWorks S/MIME 2020 Python Edition - Version 20.0 [Build 7941]