Retrieve

Retrieves an array of triggered send objects based on the specified criteria.

Retrieve(searchCriteria)

The Retrieve() function has the properties listed in this table.

PropertyTypeDescription
searchCriteriaObjectRequired. Criteria used to search for triggered send.

The searchCriteria object has the properties listed in this table.

NameTypeDescription
propertyStringRequired. The name of the field to use in the comparison.
simpleOperatorStringRequired. The comparison operator to use in the query. Possible values are:
  • equal
  • notEqual
  • lessThan
  • lessThanOrEqual
  • greaterThan
  • greaterThanOrEqual
  • like
  • isNull
  • isNotNull
  • contains
  • mustContain
  • startsWith
  • in
valueString, number, boolean, or arrayThe value to compare the specified field to.

To use the Publish() function, you must first initialize the triggered send object. Next, call the Publish() function on the initialized object.

This sample code retrieves a triggered send based on the specified filter criteria: