pigeonpost

KO | EN

gitlite — search

#hacktoberfest #llm #go #machine-learning #rust #deep-learning #linux #docker #windows #awesome #cli #vue #pytorch #ios

(★ 11)

Amazon SES E-Mail Scheduler & Delivery API

pigeonpost 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Pigeon Post

An Amazon SES E-Mail Scheduler & Delivery API.

[![Build
Status](https://travis-ci.org/tbranyen/pigeonpost.svg)](https://travis-ci.org/tbranyen/pigeonpost)

## Prerequisites

You will need the following dependencies properly installed on your computer.

* [Git](http://git-scm.com/)
* [Node.js](http://nodejs.org/) (with NPM)
* [Redis](http://redis.io/)
* [Crontab](http://crontab.org/) (Installed by default in OS X & Linux)

Note: Due to the dependency on Crontab, this application will [not run easily on
Windows](http://stackoverflow.com/questions/132971/what-is-the-windows-version-of-cron).

## Installation

``` sh
npm install pigeonpost
```

Set your Amazon SES credentials in a JSON file as [outlined in their official
docs](http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-configuring.html#Credentials_from_Disk):

``` json
{
  "accessKeyId": "test_key",
  "secretAccessKey": "test_secret",
  "region": "us-east-1"
}
```

### Bounce & Complaint handling

Amazon requires handling of bounce and complaint notices to mitigate potential
account suspension.  PigeonPost requires that you hook up SES to emit bounce
and complaint notices through Amazon SNS.  Once you have created a topic and
marked your verified email user to forward complaints to SNS, you will need to
hook up SNS to Amazon SQS.  Create a queue and have it subscribe to your SNS
topic.  On the SQS configuration page you will find a url that points to your
queue.  Add this to the configuration file discussed above like so:

``` json
{
  "accessKeyId": "test_key",
  "secretAccessKey": "test_secret",
  "region": "us-east-1",
  "sqsUrl": "https://sqs.us-east-1.amazonaws.com/12345/SES_UNDELIVERABLE"
}
```

## Usage

By design this application is meant to be standalone on a server and act as a
server daemon.  If you would like to directly integrate with your pre-existing
server, this application also acts as express middleware:

``` javascript
app.use('/email', require('pigeonpost'));
```

#### Environment variable configuration

To inform this module where the secrets file lives, set an environment
variable `AWS_SES_SECRETS` to the absolute fully qualified path on disk.  It
must be absolute as it may be run from various locations.

For example your variable may look like:

``` sh
export AWS_SES_SECRETS=/mnt/secrets/ses.json
```

## API

The API should follow [JSON-API](http://jsonapi.org/) for errors and data.  You
must set the content type request header to JSON.

*Note: jQuery and other popular request libraries may add this automatically.*

``` http
Content-Type: application/json
```

### Documentation

#### Sending

This is the endpoint you'll hit when you want to immediately send an email.
Useful for one off emails, such as new account registration or forgot password.

##### Send an email:

Request:

Example:

``` sh
curl \
  -H "Content-Type: application/json" \
  -X POST \
  -d \
  '{
     "to": ["tim@tabdeveloper.com"],
     "from": "tim@bocoup.com",
     "subject": "A test subject!",
     "body": "Test message"
   }' \
  http://localhost:8000/send
```

Response:

``` json
{
  "data": {
    "ResponseMetadata": {
      "RequestId":"2263f1cc-fccf-21e4-a378-4350dc3a1cea"
    },

"MessageId": "1120014e6373fd1e-2bdf239f-21bf-4c1f-b299-36eacb54dbc6-000000"
  }
}
```

#### Pollers

These are jobs that are executed on a specific schedule.  They are assigned using
Crontab, and allow any valid schedule expression within that format.  You would
use this endpoint to schedule emails to be sent every day/month/year, schedule
an email to be sent 5 minutes from now, etc.

##### Create a new poller:

Request:

Example:

``` sh
curl \
  -H "Content-Type: application/json" \
  -X POST \
  -d \
  '{
     "id": "test-uuid",
     "template": {
       "test-uuid",
     }
   }' \
  http://localhost:8000/poll
```

Response:

``` json
{
  "data": {}
}
```

##### Create or update new poller:

``` sh
curl \
  -H "Content-Type: application/json" \
  -X PUT \
  -d \
  '{
     "uuid": "test-uuid",
   }' \
  http://localhost:8000/poll
```

Response:

``` json
{
  "data": {}
}
```

##### Get all pollers:

Request:

Param    | Type           | Required
:------- | :------------- | :--------
No parameters

Example:

``` sh
curl \
  -X GET \
  http://localhost:8000/poll
```

Response:

``` json
{
  "data": []
}
```

##### Get specific poller:

Request:

Param    | Type           | Required
:------- | :------------- | :--------
id       | Number         | yes

Example:

``` sh
curl \
  -X GET \
  http://localhost:8000/poll/<id>
```

Response:

``` json
{
  "data": {}
}
```

##### Delete specific poller:

Request:

Param    | Type           | Required
:------- | :------------- | :--------
id       | Number         | yes

Example:

``` sh
curl \
  -X DELETE \
  http://localhost:8000/poll/<id>
```

Response:

``` json
{
  "data": {}
}
```

## Running / Development

``` sh
npm start
```

Visit the server at [http://localhost:8000](http://localhost:8000).

### Running Tests

``` sh
npm test
```

pigeonpost

pigeonpost 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

pigeonpost

pigeonpost 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README