IPWorks S/MIME 2020 Python Edition

Questions / Feedback?

on_start_transfer Event

Fired when the article text starts transferring.

Syntax

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

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

Remarks

The purpose of the on_start_transfer event is twofold: during article retrieval it fires when the article body starts transferring from the news_server to the local host, and during article posting it fires before the article body is sent to the news_server.

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

If a file is attached to the article_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) 2021 /n software inc. - All rights reserved.
IPWorks S/MIME 2020 Python Edition - Version 20.0 [Build 7941]