on_header Event

Fired every time a header line comes in.

Syntax

class IMAPHeaderEventParams(object):
  @property
  def field() -> str: ...
  @property
  def value() -> str: ...

# In class IMAP:
@property
def on_header() -> Callable[[IMAPHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[IMAPHeaderEventParams], None]) -> None: ...

Remarks

The Field parameter contains the name of the HTTP header (same case as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

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