https://github.com/dwin/fastmask
Quickly create Fastmail Masked Email addresses
https://github.com/dwin/fastmask
anonymous-email email-anonymize email-masking email-privacy fastmail masked-email privacy privacy-enhancing-technologies privacy-protection privacy-tools
Last synced: 5 months ago
JSON representation
Quickly create Fastmail Masked Email addresses
- Host: GitHub
- URL: https://github.com/dwin/fastmask
- Owner: dwin
- License: mit
- Created: 2022-03-28T18:38:37.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-09-12T06:03:20.000Z (almost 4 years ago)
- Last Synced: 2026-01-05T23:20:05.448Z (5 months ago)
- Topics: anonymous-email, email-anonymize, email-masking, email-privacy, fastmail, masked-email, privacy, privacy-enhancing-technologies, privacy-protection, privacy-tools
- Language: Go
- Homepage:
- Size: 39.1 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# fastmask
Quickly create [Fastmail](https://fastmail.com) Masked Email addresses. It includes a client package for use in other projects in addition to the CLI.
>**What is Fastmail Masked Email ?**
>
> A Masked Email address is a unique, automatically generated email address that can be used in place of your real email address.
>
> Masked Email addresses are especially useful when you need to sign up with new services online. Instead of sharing your real email address, keep it private and protect yourself from data breaches and spam by creating a new Masked Email for every service.
>
> If a Masked Email address starts receiving unwanted mail, you can simply disable that address. Masked Email addresses also make it easy to identify which service shared or leaked the address.
>
> More info: [https://www.fastmail.help/hc/en-us/articles/4406536368911-Masked-Email](https://www.fastmail.help/hc/en-us/articles/4406536368911-Masked-Email)
[](https://pkg.go.dev/github.com/dwin/fastmask)
[](https://goreportcard.com/report/github.com/dwin/fastmask)
[](https://codecov.io/gh/dwin/fastmask)
[Disclaimer](docs/Disclaimer.md) | [Privacy Policy](docs/Privacy_Policy.md) | [Terms of Service](docs/Terms_of_Service.md) | [Support](docs/Support.md)
## Installation
Get the latest releases for Linux, macOS(darwin) or Windows for armv6, armv7, arm64 and x86_64 architectures from:
[https://github.com/dwin/fastmask/releases](https://github.com/dwin/fastmask/releases) or:
```bash
go get -u github.com/dwin/fastmask
```
Or build from source.
## Usage
### CLI
```bash
fastmask login -u -p -m
fastmask create -d
```
Fastmask will store the credentials in `~/.fastmask/.config.yaml`.
_Description is optional._
_MFA code is required only if enabled for your account **(it should be)**._
### Go Package
```go
import "github.com/dwin/fastmask/pkg/fastmail"
client := fastmail.NewClient("your-app-name")
```
## License
See [LICENSE](/LICENSE) for details.
## Contributing
See [CONTRIBUTING.md](/CONTRIBUTING.md) for more information.
## Future Improvements
- [ ] Improve test coverage.
- [ ] Add support for OAuth, pending Fastmail response.
- [ ] Prompt for MFA code if needed.
- [ ] Prompt for credentials if needed.
- [ ] Add support for verbose logging output.
- [ ] Add support for listing and filtering Masked Email addresses. (currently mask be managed in Fastmail settings.)
- [ ] Add support for passing credentials via environment variables or flags for scripting.