https://github.com/pat/lipwig

Write group emails in Markdown, send via Postmark or SMTP.
https://github.com/pat/lipwig

Last synced: 17 days ago
JSON representation

Write group emails in Markdown, send via Postmark or SMTP.

• Host: GitHub
• URL: https://github.com/pat/lipwig
• Owner: pat
• Created: 2016-11-19T03:06:00.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-08-07T06:06:18.000Z (over 7 years ago)
• Last Synced: 2024-11-18T01:38:57.786Z (about 1 month ago)
• Language: Ruby
• Homepage:
• Size: 14.6 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Lipwig

Lipwig is a small tool for sending bulk emails in a slightly more friendly vibe than BCC'ing everyone.

## Why?

I have a habit of inviting friends to various events and shows, but I don't like putting everyone's email address in the _To_ field (it's not nice to disclose so many peoples' email addresses). I also don't like putting everyone in the _BCC_ field (it's nice to keep couples' email addresses together, and make the email feel at least a little more personal).

So, I'd been writing Ruby scripts to send neatly formatted emails, but Lipwig wraps up that logic and makes it a bit more re-usable.

## Installation

    $ gem install lipwig

Also, you'll need either the `postmark` gem or the `mail` gem, depending on whether you want to send via Postmark's API or by SMTP.

    $ gem install postmark

    # or

    $ gem install mail

Lipwig is known to work with Postmark >= 1.9 and Mail >= 2.6.4.

## Usage

Similar to Jekyll, Lipwig expects email files to be a mixture of YAML and Markdown. Here's an example:

    from: "Pat Allan "

    subject: "Party time"

    recipients:

     - "[email protected]",

     - - "[email protected]"

       - "[email protected]"

     - "Kylo Ren "

     cc: "General Organa