• Mailscript CLI
  • Table of Contents
  • Notes
  • Examples
  • Overview
  • Commands
  • Configuration

See getting key concepts for more info about how mailscript works. When ready take a look at the get started page

• Example YML workflow
• Combined triggers and actions
• Email to google spreadsheet
• Github action failure email to notification

In order to use the mailscript CLI must first install it wth the global flag. Run the following...

**Login local daemon**
```sh-session
$ mailscript login
... You should see a browser window open prompting you to login to your mailscript account.

Configure and manipulate email pipeline in Mailscript from the cli

VERSION
  mailscript/0.4.9 win32-x64 node-v12.18.0

USAGE
  $ mailscript [COMMAND]

TOPICS
  actions    add an action
  addresses  configure your email addresses
  keys       add an address key
  sync       import/export configuration between files and Mailscript
  triggers   add a trigger
  workflows  configure your workflows

COMMANDS
  daemon  Run a daemon to execute scripts on email arrival
  help    display help for mailscript
  login
  send    send an email from a mailscript address

• mailscript actions

Actions are what gets executed in response to a predetermined triggered. This can be sending a text message, forwarding the email, or ignoring the email entirely to a name few. Click the link above to see full list of available sub commands.

• mailscript addresses

This is where you would manage all of your mailscript addresses. Listing out created addresses, creating new addresses and deleting addresses no longer in use. Click the link above to see full list of available sub commands.

• mailscript daemon

Run a local email processing daemon. Useful for custom made email processing software.

• mailscript help [COMMAND]
• mailscript keys

Manage SMTP credientials for redirecting emails from your own email address to mailscript. Click the link above to see full list of available sub commands.

• mailscript login
• mailscript send [FILE]

Sends an email from your mailscript address

• mailscript sync:export
• mailscript sync:import

Import/export configuration to and from mailscript.

• mailscript triggers

Manage triggers. Triggers are rule sets which help mailscript know where to redirect an email to. Triggers are combined with actions to create a workflow. Click the link above to see full list of available sub commands.

• mailscript workflows

*Manage workflows. Workflows are a conjunction of actions and triggers defining the filter -> action relationship. They also include other metadata such as specifiying a different email address. It is possible to have multiple email addresses and workflows on the same account. Click the link above to see full list of available sub commands.

The mailscript CLI saves a configuration file at the follow location for windows, macOSX and Linux. In the event this must be removed for whatever reason the default location is available here.

Windows: /Users/<Username>/.mailscript

Linux: ~/.mailscript

MacOSX: ~/.mailscript