Table of Contents 📚

• Table of Contents 📚
• Features
  • Use Cases
  • Getting Started 🚀
  • Usage 👩‍💻
    • Install through npm
• Commands ⌨
• Development 💬
• License ⚖

Features

• Low code automations for your emails
• Create automations to filter and route emails as they hit your inbox.
• Create an infinte number of email addresses, and automate them individually.
• Parses every element of the email for you and provides a clean JSON object with all the metadata you will need.
• No need to transfer over to another email provider: Use your current email provider with Mailscript.
• Integrate your own custom coded email filters. Filter based on key words, or email header contents.
• Redirect high priority emails to your primary inbox, keeping it clean of clutter.

Use Cases

• Send a text message to your phone upon receiving an important email
• Auto reply to first time senders.
• Save important attachments to a file server, or location of choice.

Getting Started 🚀

• Read our documentation
• Take a look at the HTTP API documentation

Usage 👩‍💻

Install through npm

In order to use the Mailscript CLI, you must first install it with the global flag. Run the following:

$ npm install -g mailscript

Alternatively, you could install the dev version (not recommended!)

$ npm install -g https://github.com/mailscript/cli.git

Basic usage

$ mailscript COMMAND
running command...
$ mailscript (-v|--version|version)
mailscript/0.4.8 darwin-x64 node-v14.15.0
$ mailscript --help [COMMAND]
USAGE
  $ mailscript COMMAND
...

Login via local daemon

$ mailscript login
... 
You should see a browser window open prompting you to login to your Mailscript account. 
The daemon will handle the rest upon completion

Commands ⌨

Ready to dive into Mailscript? Read the command line documentation

Development 💬

Development information available here

License ⚖

CLI license: MIT