localFile (property)

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

Syntax

• Objective-C
• Swift

@property (nonatomic,readwrite,assign,getter=localFile,setter=setLocalFile:) NSString* localFile;
- (NSString*)localFile;
- (void)setLocalFile:(NSString*)newLocalFile;

public var localFile: String {
  get {...}
  set {...}
}

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.