Command Property

Can be used to send additional commands directly to the server.

Syntax

 pimap.setCommand( command, [callback])

Default Value

""

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 getCommand([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 setCommand([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

Setting this property directs the class to send the assigned command to the MailServer.

Check the LastReply property and/or trap the PITrail events coming from the server to get the response(s).

This property is write-only and not available at design time.

Data Type

String