Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Read and write to DynECT Email REST API
JavaScript
Branch: master

Merge pull request #2 from ethanlarochelle/dev

HTTPS, Logging, and query-strings for arrays
Failed to load latest commit information.
example added support for ssl requests. fixed minor bug preventing the user f…
lib Updating package tag
tests added support for ssl requests. fixed minor bug preventing the user f…
History.md
LICENSE
README.md updated the readme to reflect the new options.
package.json

README.md

dynectemail-node

Read and write DynECT Email.

Installation

npm install dynectemail

Usage

var DynectEmailNode = require('dynectemail').DynectEmailNode;

var dynectemail = new DynectEmailNode({
    apikey: 'apikey',                // Required. You can get this from the Integration page http://email.dynect.net/index.php?Page=Integration
    useragent: 'appname/vX.X MyApp', // Optional. Defaults to 'dynectemail-node'.
    format: 'json',                  // Optional. Defaults to 'json'. (json, xml, html)
    secure: true                     // Optional. Defaults to false. Will force ssl(port 443) if true.
});

Documentation

DynectEmailRequest

dynectemail.request(method, options, reqtype);

Returns a DynectEmailRequest instance.

Send request to DynECT Email. Requests automatically include the API key and are signed and/or sent via POST as described in the DynECT Email REST API documentation.

Methods:

Accepts any DynECT Email REST API method name, eg "reports/sent/count".

Options:

All options are passed through to DynectEmail with the exception of the following.

  • handlers

    Default event handlers to attach to the request object on creation.
    

Events:

  • success(json)

    JSON response from DynECT Email
    
  • error(error)

    An error returned by a transmission error.
    

Influences

Heavily drawn from jammus's lastfm-node
http://github.com/jammus/lastfm-node

Something went wrong with that request. Please try again.