IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

ReturnPath Property

Sets the Return-Path to be used for sending email.

Syntax

 smtp.getReturnPath([callback])
 smtp.setReturnPath( returnPath, [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 getReturnPath([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 setReturnPath([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 sets the Return-Path to be used for sending email. If this is not set, the value in the From property is used.

Data Type

String

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0