MessageSender Property

The address of the sender of the message.

Syntax

 imap.getMessageSender([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 getMessageSender([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 setMessageSender([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

This property contains the address of the sender of the message. Which is normally the same value as MessageFrom.

There are cases when a message may have more than one sender. If this is the case, the addresses are provided in the MessageSender property separated by commas.

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

Data Type

String