https://github.com/kevgathuku/mailer

Mass newsletter mailing with Go
https://github.com/kevgathuku/mailer

Last synced: about 1 month ago
JSON representation

Mass newsletter mailing with Go

• Host: GitHub
• URL: https://github.com/kevgathuku/mailer
• Owner: kevgathuku
• License: mit
• Created: 2015-11-09T19:06:16.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-11-10T06:24:59.000Z (about 9 years ago)
• Last Synced: 2024-06-20T10:06:14.418Z (6 months ago)
• Language: Go
• Homepage:
• Size: 0 Bytes
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Mailer

Mass Newsletter Mailing with Go

## Introduction

This application seeks to make sending emails in bulk easier.

It is particularly suited to sending a single email e.g. a newsletter to many users asynchronously, something Go is extremely good at.

##  Requirements

This package only requires that you have Go installed and you have configured your `$GOPATH` 

* [Installing Go](https://golang.org/doc/install)

* [Configuring $GOPATH](https://golang.org/doc/code.html)

## Installation

Assuming that your `$GOPATH` is already set, install the application by running:

`$ go install https://github.com/kevgathuku/mailer`

You should now be able to launch the app by running:

`$ mailer`

## Usage

The application by default runs as a web application on port 3102.

You can also specify the port by setting the `PORT` environment variable.

The application accepts input through a JSON POST request in the following format:

```JSON

{

	"title": "Title of the newsletter",

	"content": "HTML content of the newsletter",

	"subscribers": ["[email protected]", "[email protected]", "[email protected]"]

}

```

Once the POST request is received, the email is sent to the subscribers specified asynchronously.

The sending progress is displayed on the command line

## Configuration

The application expects the follwing environment variables to be set:

```

SENDER_ADDRESS  # The Email to use as the FROM address

SMTP_HOST		# The SMTP host to use

SMTP_PORT		# SMTP Port to use

SMTP_USERNAME  	# SMTP username, if any

SMTP_PASSWORD  	# SMTP port, if any

```

## Contributing

I am a noob at GO and I welcome any contributions that would help make this application better.

Any help would be greatly appreciated

----

Made with ♥ by [Kevin Ndung'u](https://github.com/kevgathuku)