Aliasman is a CLI tool for managing a larger number of email aliases. Since I've had my own domain, I've been generating email aliases for every company I do business with on the internet for a number of years and this is the tool that I use to manage it.
Aliasman currently uses two kinds of providers. First is an email_type provider that is the email service API for creating and deleting the aliases. Second is a storage_type provider that is the API storing the information about the aliases and holds information that is not typically stored in the email_type (such as a description of the alias and when it was created/modified). The storage_type, generally, should be more easily queryable for faster lookups.
The tool is currently only tested on Mac OS X systems, but should just work on other UNIX like systems that have a Go compiler. With minimal work, it should work fine on Windows too but this is currently untested.
Installing aliasman is easy. First, use go get to install the latest version of the application
from GitHub. This command will install the aliasman executable in the Go path:
go get -u github.com/patsoffice/aliasman
The above command requires a working Go compiler installed.
brew tap patsoffice/tools
brew install aliasman
Aliasman has a command used to configure all of the available providers:
aliasman config
The program will then prompt for information relevant to the operation of the provider.
Aliasman supports the following providers and their configuration options (stored in the configuration file):
files- Stores alias metadata in JSON blobs locally (can be replicated by Dropbox, Keybase, etc.)gsuite- The API fronting G Suite Admin API (email_type)- Create a project
- Create a credential
- Click "+ CREATE CREDENTIALS"
- Select "OAuth client ID"
- Fill out consent screen (probably want it to be internal)
- Create OAuth client ID for application type "Other"
- Download the "OAuth 2.0 Client ID" created and name it "gsuite-credentials.json"
- Run
aliasman configand configure thegsuiteemail provider
rackspace_email_api- The API fronting Rackspace Email (email_type)rackspace_api_user_key- Rackspace API user key (link to get/make API key)rackspace_api_secret_key- Rackspace API secret key
s3- Amazon Web Services' Simple Storage Service (storage_type)s3_region- The S3 endpoint to connect tos3_bucket- The S3 bucket to uses3_access_key- The AWS IAM user access key to use. The user needs the following IAM permissions for the specifieds3_bucketresource:- s3:ListBucket
- s3:GetObject
- s3:PutObject
s3_secret_key- The AWS IAM user secret key to use
sqlite3- SQLite is a small, fast, self-contained, high-reliability, full-featured, SQL database engine (storage_type)sqlite_db_path- The path for the SQLite database file
Once configured, Aliasman can be used to create an email alias. In this case, we will be creating a random email address with the use of the -r flag. However, we could have supplied an alias of our choosing with -a alias.
aliasman alias create -d example.com -D "company.com" -r -e person1@example.com,person2@example.com
This will create both an email alias with our email_type provider and an entry with our storage_type provider. The output of the above command is:
Created alias 5f888d1272833b09@example.com that points to person1@example.com, person2@example.com
Since we likely won't remember the alias name that was created for us, we can for the alias in the future with the search subcommand:
aliasman alias search -s company.com
┌───┬──────────────────┬─────────────┬──────────────────────────────────────────┬─────────────┬───────────┬──────────────────────┬──────────────────────┬────────────────┐
│ │ Alias │ Domain │ Email Address(es) │ Description │ Suspended │ Created Time │ Modified Time │ Suspended Time │
├───┼──────────────────┼─────────────┼──────────────────────────────────────────┼─────────────┼───────────┼──────────────────────┼──────────────────────┼────────────────┤
│ 1 │ 5f888d1272833b09 │ example.com │ person1@example.com, person2@example.com │ example.com │ No │ 2020-03-28T13:46:43Z │ 2020-03-28T13:46:43Z │ │
└───┴──────────────────┴─────────────┴──────────────────────────────────────────┴─────────────┴───────────┴──────────────────────┴──────────────────────┴────────────────┘
When we don't want to do business with example.com anymore, we can suspend the alias. This will keep the information in the storage_type provider but will disable or delete the alias in the email_type provider:
aliasman alias suspend -d example.com -a 5f888d1272833b09
If we search for our alias again we see that it's suspended status is Yes and a suspended timestamp is set:
aliasman alias search -s company.com
┌───┬──────────────────┬─────────────┬──────────────────────────────────────────┬─────────────┬───────────┬──────────────────────┬──────────────────────┬──────────────────────┐
│ │ Alias │ Domain │ Email Address(es) │ Description │ Suspended │ Created Time │ Modified Time │ Suspended Time │
├───┼──────────────────┼─────────────┼──────────────────────────────────────────┼─────────────┼───────────┼──────────────────────┼──────────────────────┼──────────────────────┤
│ 1 │ 5f888d1272833b09 │ example.com │ person1@example.com, person2@example.com │ example.com │ Yes │ 2020-03-28T13:46:43Z │ 2020-03-28T13:46:43Z │ 2020-03-28T14:53:42Z │
└───┴──────────────────┴─────────────┴──────────────────────────────────────────┴─────────────┴───────────┴──────────────────────┴──────────────────────┴──────────────────────┘
If we don't want a record of the alias anymore, it can be deleted:
aliasman alias delete -d example.com -a 5f888d1272833b09
Full help is always available for commands and sub-commands with --help.
Aliasman uses go-extpoints for registering providers. If any changes are made to the provider interfaces, the extpoints will need to be regenerated.
go install github.com/progrium/go-extpoints
go generate ./...