Skip to content

A simple CLI tool for managing Fastmail masked email aliases

License

Notifications You must be signed in to change notification settings

fredrikrab/masked_fastmail

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Masked Fastmail

A simple CLI tool for managing Fastmail masked email aliases. Easily create new aliases for websites or manage existing ones.

Features

  • Get or create masked email addresses for domains
  • Aliases are automatically copied to clipboard
  • Enable/disable/delete aliases

Usage

demo

Usage:
  masked_fastmail <url>   (no flags)
  manage_fastmail <alias> [flags]

Flags:
      --delete    delete alias (bounce messages)
  -d, --disable   disable alias (send to trash)
  -e, --enable    enable alias
  -h, --help      show this message
  -v, --version   show version information

The following environment variables must be set:

export FASTMAIL_ACCOUNT_ID=your_account_id
export FASTMAIL_API_KEY=your_api_key

Examples

Get or create alias

A new alias will only be created if one does not already exist. In either case, the alias is automatically copied to the clipboard.1

masked_fastmail example.com

Enable an existing alias

New Fastmail aliases are initialized to pending, and are set to enabled once they receive their first email. However, they get automatically deleted if no email is received within 24 hours. Some services may not send a timely welcome email, in which case it's helpful to manually enable the alias.

masked_fastmail --enable [email protected]

Disable an alias

This causes all new new emails to be moved to trash.

masked_fastmail --disable [email protected]

Installation

Option 1: Download a pre-built binary

Download the latest release from the releases page.

Option 2: Use go install

go install github.com/fredrikrab/masked_fastmail@latest

Option 3: Build from source

  1. Clone the repository
  2. Run go build -o masked_fastmail

Prerequisites

  • Go 1.22+
  • Fastmail API credentials

API documentation

License

BSD 3-Clause License

Footnotes

  1. Copying is done with Clipboard for Go and should work on all platforms.