Postmark-Tracking
Postmark Tracking is a wrapper for the postmark tracking API. Find more details on the official documentation
Installation
npm install postmark-tracking --save
Documentation#
Track message with a unique id
var Postmark = ;var tracker = 'xxx-xxx-xxx-xxx' //Postmark token tracker;
Track message with a unique id and options
Options:
- count : Limit the number of message opens to return per request, max of 500. (default: 10)
- offset : Specify the number of messages to skip.(default: 0)
...tracker;
Track messages with filters
Options:
- recipient: Filter by the value of the To, Cc, or Bcc fields.
- tag: Filter by tag.
- client_name: Filter by the client name, i.e. Outlook, Gmail.
- client_company: Filter by the client company, i.e. Microsoft, Apple, Google.
- client_family: Filter by the client family, i.e. OS X, Chrome.
- os_name: Filter by the full OS name and specific version, i.e. OS X 10.9 Mavericks
- os_family: Filter by the kind of OS used without specific version, i.e. OS X, Windows.
- os_company: Filter by the company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation.
- platform: Filter by the platform, i.e. webmail, desktop, mobile.
- country: Filter by the country messages were opened in, i.e. Denmark, Russia.
- region: Filter by the full name of region messages were opened in, i.e. Hauts-de-Seine, Pennsylvania.
- city: Filter by the full name of city messages were opened in, i.e. Minneapolis, Philadelphia.
...tracker;
Using promises
...tracker;
Version
1.0.0
Todo's
Write Test
License
MIT
Free Software, Hell Yeah!