Cloud Mail 2020 Node.js Edition

Questions / Feedback?

SearchCriteriaLabels Property

A space separated list of labels to use when searching.

Syntax

 gmail.getSearchCriteriaLabels([callback])
 gmail.setSearchCriteriaLabels( searchCriteriaLabels, [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 getSearchCriteriaLabels([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 setSearchCriteriaLabels([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

A space separated list of labels to use when searching.

This property specifies a space separated list of labels to be used when searching. Messages with matching labels will be returned. Labels that include spaces must be quoted, for instance: "My Label".

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]