Skip to content

ShotgunMailer shoots your organization's email hassle in the face!

Notifications You must be signed in to change notification settings

dnpena/ShotgunMailer

Repository files navigation

#ShotgunMailer

ShotgunMailer shoots your organization's email hassle in the face!

If you work on an organization that uses shared addresses like contact@yourdomain.com or sales@yourdomain.com, this is for you. If you just want a serious and private email address, this is also for you. And did I mention it is FREE?

With ShotgunMailer you have more control over your organization's emails and you can avoid double answers and inconsistency. (And it doesn't have to cost you 5USD per account. It's your server, your privacy, your money.)

On the other hand, if you just want to have a mailbox of your own, this is a very private (and nice) way of having one.

##Getting started

The first step is to actually buy a domain on a site like Godaddy. From now on we're going to call it yourdomain.com.

Clone this repo from GitHub, push it to Heroku(from now on http://example.herokuapp.com) and install the MailGun add-on. Other add-ons like pg-backups and NewRelic are highly recommended.

To handle the DNS, I recommend using Cloudflare and following this heroku documentation. Don't forget to add the domain in the settings section of your heroku app, otherwise you'll get an "This app doesn't exist" error.

Now, by clicking on the MailGun add on you will be on logged on to your account. Here you should follow the oficial documentation and verify your domain. This could take a while on their end. Make sure you setup the "Spam Filter Settings" to deliver the emails but with flags.

You should rename the config/public_application.yml to config/application.yml(and optionally add a S3 account for Avatars and other stuff). Once you have your user/pass, copy them in the config/application.yml file. Remember to set the ENV variables with rake figaro:heroku and restart your server to test locally.

Now for the last part, you need to setup your MailGun Routes in the routes tab accessed through Heroku. You should make all routes send the emails as post to http://example.herokuapp.com/emails so that they appear on your inbox.

Thats it. Now you can send and receive emails as **@yourdomain.com

##Pending Tasks / Ideas

  • Ability to mark emails and senders as spam and see them in a spam folder
  • Upgrade to a stable version of bootstrap 3
  • Deliver spam, but add X-Mailgun-SFlag and X-Mailgun-SScore headers
  • Separate emails when adding commas. Use some tag-input css & js
  • New design like Airmail or something
  • See the senders "real name" and not just the ugly email
  • When the inbox is empty, show "INBOX ZERO"
  • Autodelete spam after 15 days
  • Check events authenticity with Mailgun's signature?
  • Add Atachments to emails
  • Add the ability to create 'groups' so that some can send and receive as that address(work@example.com)
  • Only show emails in inbox that are for the user or that are global
  • Add pagination to emails (scroll down and pull to refresh?)
  • Add email actions as batch. It should work first selecting emails and then selecting the action.
  • Add signature to users (dynamic signatures?)
  • Add a little AJAX and/or Angular.js
  • Add tests
  • Add a different admin interface, with basic usage graphs
  • Setup alternative_email to send notifications to(as an alert)
  • Implement a robust and hopefully somewhat Restful API using INBOX
  • Create a Demo with link to heroku
  • Use central domain shotgunmailer.com
  • Make mobile apps and dream on
  • ...

##Contributing

If you make improvements to this application, please share with others.

  • Fork the project on GitHub.
  • Make your feature addition or bug fix.
  • Commit with Git.
  • Send the author a pull request.

If you add functionality to this application, create an alternative implementation, or build an application that is similar, please contact me and I'll add a note to the README so that others can find your work.

##Credits

Developed by Max Findel & the team at Brainshots

About

ShotgunMailer shoots your organization's email hassle in the face!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published