hermes

README

HERMES

About project technology

• TODO: More info here

WorkInProgress

This project is under construction and could be not work correctly right now. If you wish to test it you can:

• Clone it

  $ mkdir -p $GOPATH/src/github.com/iver/
  $ git clone http://github.com/iver/hermes $GOPATH/src/github.com/iver/hermes
  $ cd $GOPATH/src/github.com/iver/hermes
  

• Set environment variables

  export MANDRILL_KEY="YOUR-MANDRILL-APIKEY"
  export SENDGRID_API_KEY="YOUR-SENDGRID-APIKEY"
  export MG_API_KEY="YOUR-MAILGUN-PRIVATE-APIKEY"
  export MG_PUBLIC_API_KEY="YOUR MAILGUN-PUBLIC-APIKEY"
  export MG_DOMAIN="YOUR-MAILGUN-DOMAIN"
  
  export SENDGRID_USER="someuser@email.com"
  export MG_EMAIL_TO="someuser@email.com"
  export MANDRILL_USER="someuser@email.com"
  

• Compile it

  $ make build
  

• Run it

  $ cd bin/
  $ ./hermes
  

Content

• Why hermes
• How to install
• Project organization
• Copyright and license

Why hermes

Howto install

• TODO: Add descriptions and steps

Project organization

TODO: Add description

---

Copyright and license

---

Copyright (c) 2014-2016 Iván Jaimes. See LICENSE for details.

Documentation

Index

• Variables
• type EmailProvider
  • func New(cfile string) (e *EmailProvider, err error)
  • func (e *EmailProvider) NewEmail(sn interface{}, s string, t interface{}, r interface{}) (email interface{}, err error)
  • func (e *EmailProvider) NextProvider()
  • func (e *EmailProvider) Order() string
  • func (e *EmailProvider) Selected() (pn string)
  • func (e *EmailProvider) Send(m interface{}) (err error)
  • func (e *EmailProvider) Sort(order ...string) (err error)

Variables

var (
	DefaultOrder = []string{"mailchimp", "mailgun", "sendgrid"}
)

Types

type EmailProvider

type EmailProvider struct {
	ConfigFile string
	Providers  *ring.Ring
}

func New

func New(cfile string) (e *EmailProvider, err error)

func (*EmailProvider) NewEmail

func (e *EmailProvider) NewEmail(sn interface{}, s string, t interface{}, r interface{}) (email interface{}, err error)

func (*EmailProvider) NextProvider

func (e *EmailProvider) NextProvider()

func (*EmailProvider) Order

func (e *EmailProvider) Order() string

func (*EmailProvider) Selected

func (e *EmailProvider) Selected() (pn string)

func (*EmailProvider) Send

func (e *EmailProvider) Send(m interface{}) (err error)

Send ...

func (*EmailProvider) Sort

func (e *EmailProvider) Sort(order ...string) (err error)