max_lines Property

The maximum number of message lines besides headers to retrieve.

Syntax

def get_max_lines() -> int: ...
def set_max_lines(value: int) -> None: ...

max_lines = property(get_max_lines, set_max_lines)

Default Value

0

Remarks

This property is used to limit the number of text lines besides headers retrieved for messages. It can be used to preview message headers and a portion of their contents, without incurring the overhead of downloading the entire message.

The default value of the property is 0. In this case the entire message will be retrieved, without interruptions. Note: If you are not retrieving the entire message (max_lines is nonzero), no data will be written to local_file.