Project

mailqun

0.0
No commit activity in last 3 years
No release in over 3 years
mailqunharman28/mailqunHomepageDocumentationSource CodeBug TrackerWiki
Mailgun's website is stupid, so this script lets you query events from commandline.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
12,359
Stars
4
Forks
1
Watchers
3
 Releases
Current version
0.2.1
Total releases
6
First release
2017-11-10
Latest release
2018-04-25
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
1
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2017-07-17
Reverse Dependencies
0

 Dependencies

Runtime

colorize
~> 0.8.1
 Project Readme

Mailqun

Mailgun's website is stupid, so this executable gem lets you query events from commandline.

Usage

Install:

gem install mailqun

Set the following env variables:

MAILGUN_DOMAIN=domain.com
MAILGUN_SECRET=key-lalala.domain.secret

And now:

$> mailqun -h
Usage: mailqun [options]

Common options:
    -f, --from [FROM]                Address of the sender
    -t, --to [TO]                    Address of the receiver
    -s, --subject [SUBJECT]          Subject of mail
    -l, --limit [LIMIT]              Limit on number of results
        --tags [TAG]                 Value in X-Mailgun-Tag header
    -e, --event [EVENT]              Event being queried

Bounce options:
        --bounces                    Add this option to query bounces instead of events
    -a, --address [ADDRESS]          Bounced address, used with --bounces
        --delete [ADDRESS]           Delete address from bounces, used with --bounces

View options:
        --view-body [URL]            Mailgun storage URL to fetch email body from

Examples:

Fetch one delivery event for a mail addressed to harman28@gmail.com with the word 'potato' in the subject

$> mailqun --to harman28@gmail.com --event delivered --subject potato --limit 1

Fetch ten acceptance events for mails sent by care@domain.com with the tag 'cool'

$> mailqun -f care@domain.com -e accepted --tags cool --limit 10

Check if lololol@wut.com is on the bounce list

$> mailqun --bounces -l 2 -a lololol@wut.com

View body of email stored in some Mailgun url

$> mailqun --view-body "https://sw.api.mailgun.net/v3/domains/domain.com/messages/uglyhash"
# => Saves mail in a .html file and opens using default program

Contributing

I am aware that this script is a mess. It was born as a result of frustration arising from seeing Mailgun's "Don't get angry" page a few times too many. I would welcome improvements, both features and design changes. Bug reports and pull requests are welcome on the GitHub repo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.