on_pi_trail Event

Traces the commands sent to the mail server, and the respective replies.

Syntax

class FileMailerPITrailEventParams(object):
  @property
  def direction() -> int: ...
  @property
  def message() -> str: ...

# In class FileMailer:
@property
def on_pi_trail() -> Callable[[FileMailerPITrailEventParams], None]: ...
@on_pi_trail.setter
def on_pi_trail(event_hook: Callable[[FileMailerPITrailEventParams], None]) -> None: ...

Remarks

The on_pi_trail event is useful for debugging purposes. It shows all the interaction between the client and the server, line by line, except for message header and body transfers.

The Message parameter contains the full text of the message. The Direction parameter shows the originator of the message:

0 (Client)The Message originates from the client.
1 (Server)The Message originates from the server.
2 (Info)The Message is an informative message originating from the client software (the class code).

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