ServerInfoExpireSupported Property

Indicates whether the POP3 server supports the EXPIRE extension.

Syntax

 pop3client.getServerInfoExpireSupported([callback])

Default Value

FALSE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getServerInfoExpireSupported([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setServerInfoExpireSupported([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Indicates whether the POP3 server supports the EXPIRE extension. See ServerInfoExpirationPeriod field.

This property is read-only.

Data Type

Boolean