IPWorks OpenPGP 2020 Node.js Edition

Questions / Feedback?

MessageId Property

The Message Identifier for the message.

Syntax

 phtmlmailer.getMessageId([callback])
 phtmlmailer.setMessageId( messageId, [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 getMessageId([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 setMessageId([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 Message Identifier for the message. When set, the value of MessageId is used as the Message-ID header value of the message. A special value of "*" will automatically generate a random unique identifier for the message.

This property is not available at design time.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks OpenPGP 2020 Node.js Edition - Version 20.0 [Build 8249]