on_start_transfer Event

Fired when the message text starts transferring.

Syntax

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

# In class SMTP:
@property
def on_start_transfer() -> Callable[[SMTPStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[SMTPStartTransferEventParams], None]) -> None: ...

Remarks

If message_text is not empty, the on_start_transfer event is fired when the message_text starts transferring from the local host to the mail_server. If message_text is empty, the event is not fired.

If a file is attached to the message_text via the attached_file property, then on_start_transfer fires again when the file starts transferring. Please go to the description of the attached_file property for more information.

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

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