LocalFile Property

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

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

inedi_pop_get($res, 13 );
inedi_pop_set($res, 13, $value );

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 Transfer event. Note: If you are not retrieving the entire message (MaxLines is nonzero), no data will be written to LocalFile.

Data Type

String