IPWorks OpenPGP 2020 Python Edition

Questions / Feedback?

on_transfer Event

Fired while the message gets transferred from MailServer .


class PPOPTransferEventParams(object):
  def direction() -> int: ...
  def bytes_transferred() -> int: ...
  def percent_done() -> int: ...
  def text() -> bytes: ...
  def eol() -> bool: ...

# In class PPOP:
def on_transfer() -> Callable[[PPOPTransferEventParams], None]: ...
def on_transfer(event_hook: Callable[[PPOPTransferEventParams], None]) -> None: ...


The Text parameter contains the portion of the message 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. For complete lines, there is no terminating newline at the end of the Text parameter, and EOL is True. The EOL parameter is False when a line is broken (usually for being too long).

A faster way to retrieve a message is to assign a value to the local_file property and use the on_transfer event 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.

NOTE: For the PercentDone parameter value to be correct, the GetMessageSize must be set to true.

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