on_transfer Event
Fired while the message text gets transferred to MailServer .
Syntax
class SHTMLMailerTransferEventParams(object): @property def direction() -> int: ... @property def bytes_transferred() -> int: ... @property def percent_done() -> int: ... # In class SHTMLMailer: @property def on_transfer() -> Callable[[SHTMLMailerTransferEventParams], None]: ... @on_transfer.setter def on_transfer(event_hook: Callable[[SHTMLMailerTransferEventParams], 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.