local_file Property

The path to a local file for downloading the message body. If the file exists, it is overwritten (optional).

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

This property is used when retrieving a message. If this property is empty then the received data is provided through the parameters of the on_transfer event. Note: If you are not retrieving the entire message (max_lines is nonzero), no data will be written to local_file.