SearchCriteriaString Property
The Gmail search string.
Syntax
gmail.getSearchCriteriaString([callback]) gmail.setSearchCriteriaString( searchCriteriaString, [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 getSearchCriteriaString([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 setSearchCriteriaString([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 Gmail search string.
This property may contain a Gmail search string. The search string syntax is the same as the advanced search options in the Gmail web interface. For instance "has:attachment in:unread".
This property is not available at design time.
Data Type
String