Cloud Mail 2020 Node.js Edition

Questions / Feedback?

SearchCriteriaThreadId Property

The thread Id to search for.

Syntax

 gmail.getSearchCriteriaThreadId([callback])
 gmail.setSearchCriteriaThreadId( searchCriteriaThreadId, [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 getSearchCriteriaThreadId([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 setSearchCriteriaThreadId([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 thread Id to search for.

This property defines the thread Id to search for. This can be used to retrieve all messages in a conversation.

This property is not available at design time.

Data Type

String

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Mail 2020 Node.js Edition - Version 20.0 [Build 7718]