Introduces GitHub issue and PR templates, contributing and security documentation. Adds Android 12+ splash screen support, updates theming and status color handling, and improves MaskedEmail card/detail UI with shared transitions and accessibility. Updates dependencies for Compose and Material3, and enhances README with detailed setup and contribution instructions. |
||
|---|---|---|
| .github | ||
| .gradle | ||
| .idea | ||
| app | ||
| docs | ||
| gradle/wrapper | ||
| .gitattributes | ||
| .gitignore | ||
| build.gradle.kts | ||
| CONTRIBUTING.md | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| LICENSE | ||
| local.properties | ||
| README.md | ||
| SECURITY.md | ||
| settings.gradle.kts | ||
FastMask
Native Android app for managing Fastmail masked emails
Features • Screenshots • Installation • Setup • Tech Stack • Architecture • Contributing
About
FastMask is a native Android application that lets you manage your Fastmail masked email addresses directly from your phone. Masked emails are disposable addresses that forward to your real inbox, helping you protect your privacy and reduce spam.
Features
| Feature | Description |
|---|---|
| View All Masks | Browse your masked emails in a clean, searchable list |
| Create New | Generate new masked addresses with custom descriptions |
| Enable/Disable | Toggle masks on or off without deleting them |
| Edit Details | Update description, domain, and URL associations |
| Quick Copy | One-tap copy to clipboard |
| Delete | Remove masks you no longer need |
| Search & Filter | Find specific masks instantly |
| Material You | Dynamic theming that adapts to your wallpaper |
Screenshots
Screenshots coming soon
Installation
Download APK
- Go to the Releases page
- Download the latest APK file
- Enable "Install from unknown sources" if prompted
- Install the APK
Build from Source
# Clone the repository
git clone https://github.com/pawelorzech/FastMask.git
cd FastMask
# Build debug APK
./gradlew assembleDebug
# Or build release APK
./gradlew assembleRelease
The APK will be generated in app/build/outputs/apk/
Requirements
- Android 8.0 (API 26) or higher
- Fastmail account with API access
Setup
1. Create a Fastmail API Token
- Log in to Fastmail
- Navigate to Settings → Privacy & Security → Integrations → API tokens
- Click New API token
- Name it (e.g., "FastMask")
- Select scope: Masked Email (read/write)
- Copy the generated token
2. Log in to FastMask
- Open the app
- Paste your API token
- Tap "Log in"
Your token is stored securely using Android's EncryptedSharedPreferences.
Tech Stack
| Category | Technology |
|---|---|
| Language | Kotlin 100% |
| UI Framework | Jetpack Compose |
| Design System | Material 3 with dynamic theming |
| DI | Hilt |
| Networking | Retrofit + OkHttp |
| Serialization | Kotlinx Serialization |
| Async | Coroutines + Flow |
| API Protocol | JMAP (Fastmail's native protocol) |
Architecture
The app follows Clean Architecture principles with MVVM pattern:
app/
├── data/ # Data layer
│ ├── api/ # JMAP API service & models
│ ├── local/ # Secure token storage
│ └── repository/ # Repository implementations
│
├── domain/ # Business logic layer
│ ├── model/ # Domain models
│ ├── repository/ # Repository interfaces
│ └── usecase/ # Use cases
│
├── di/ # Dependency injection modules
│
└── ui/ # Presentation layer
├── auth/ # Login screen
├── list/ # Masked email list
├── create/ # Create new mask
├── detail/ # View/edit mask details
├── components/ # Reusable UI components
├── navigation/ # Navigation setup
└── theme/ # Material 3 theming
Privacy & Security
- Local Storage Only: Your API token is stored locally using Android's EncryptedSharedPreferences
- Direct API Communication: The app communicates directly with Fastmail's servers - no intermediary servers
- No Tracking: Zero analytics, telemetry, or data collection
- Open Source: Full source code available for audit
Contributing
Contributions are welcome! Here's how you can help:
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Development Setup
- Install Android Studio (latest stable)
- Clone the repository
- Open the project in Android Studio
- Sync Gradle and run on an emulator or device
Code Style
- Follow Kotlin coding conventions
- Use meaningful commit messages
- Write tests for new features when applicable
Roadmap
- Add screenshots to README
- Biometric authentication option
- Widget for quick mask creation
- Export/import functionality
- Dark/light mode toggle
- Localization support
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgments
- Fastmail for their excellent email service and JMAP API
- JMAP for the open standard specification
- The Android and Kotlin communities for amazing tools and libraries
Made with Kotlin and Jetpack Compose