Proton Mail

Contributing We’ve recently rebuilt the app and are focused on our current roadmap of features and fixes. Therefore, we are not accepting new issues or PRs at the moment: feel free to fork the repo for your own experiments. We appreciate your understanding and support. Build instructions Install and configure the environment (two options available) Android Studio bundle Standalone Android tools Install and configure Java 17+ (not needed for Android Studio bundle as it's included) Install Java 17 with brew install openjdk@17 apt install openjdk-17-jdk Set Java 17 as the current version by using the JAVA HOME environment variable Clone this repository (Use git clone [email protected]:ProtonMail/android-mail.git .) Ensure Git LFS is installed ( git lfs install ) for snapshot test assets Setup google-services.json file by running ./scripts/setup google services.sh Build with any of the following: Execute ./gradlew assembleAlphaDebug in a terminal Open Android Studio and build the :app module Deploy Each merge to main branch builds the branch's HEAD and deploys it to Firebase App Distribution. We use Sentry for crash/error reporting (primarily for non-debuggable builds). Runtime crash/error reporting : the DSN is injected at build time via environment variables ( SENTRY DSN MAIL and SENTRY DSN ACCOUNT ). If these variables are not set (typical for local builds and forks), Sentry is effectively disabled. Mapping/symbol uploads (CI / release tasks) : CI provides a sentry.properties file for uploading ProGuard/R8 mappings and native symbols. This project's code style and formatting is checked by detekt. The rule set is ktlint's default one.