MsgReturnPath Property
The value of the Return-Path header property.
Syntax
imapclient.getMsgReturnPath([callback]) imapclient.setMsgReturnPath( msgReturnPath, [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 getMsgReturnPath([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 setMsgReturnPath([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
The value of the Return-Path header field.
This field contains the address to which this message shall be returned in case of unsuccessful delivery.
This property is not available at design time.
Data Type
String