• This repository has been archived on 14/May/2024
  • Stars
    star
    1,741
  • Rank 26,741 (Top 0.6 %)
  • Language
    Kotlin
  • License
    GNU General Publi...
  • Created over 4 years ago
  • Updated 6 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Proton Mail Android app

Proton Mail for Android

Copyright (c) 2020 Proton AG

License

The code and data files in this distribution are licensed under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. See https://www.gnu.org/licenses/ for a copy of this license.

See LICENSE file

Setup

The most straightforward way to build and run this application is to:

  • Install Android Studio: https://developer.android.com/studio/install
  • Clone the repository. You have two options:
    • Use the Project from version control in Android Studio, or
    • Use the git clone command and import it into Android Studio
  • Build and run the app directly in Android Studio

Alternatively, if you want to build the app directly from the command line (or using a different IDE, etc.), you will first need to install the command line tools from: https://developer.android.com/studio#cmdline-tools. Then you will need to install the SDK using the sdkmanager tool. After cloning the repository with git clone you will need to edit the local.properties file so that it points to the location of the SDK. Depending on which operating systems you use, the location of the SDK is usually:

  • Windows: C:\Users\<username>\AppData\Local\Android\sdk
  • MacOS: /Users/<username>/Library/Android/Sdk/
  • Linux: /home/<username>/Android/Sdk/

Then, go to the app’s root directory in the command line tool and run:

  • ./gradlew assembleBetaDebug
  • adb install ./app/build/outputs/apk/beta/debug/ProtonMail-Android-1.XX.X-beta-debug.apk

Note: In app notifications when building from source

When building from source, in app push notifications for new emails will not work out of the box.

The app uses Google's Firebase Cloud Messaging (FCM) service to deliver push notifications. However, we are not publishing the production version of the configuration files needed to set up this service, because the values specified within are deemed sensitive. Instead, we publish dummy versions of the files (config/google-services/dummy-google-services.json and config/google-services/dummy-google-services-beta.json) which allows you to build the app without push notifications. The dummy files will be copied to the relevant folders once you run the ./gradlew command.

We may offer alternative push notification systems in the future which do not rely on Google services.

Contributions

Contributions are appreciated, but must conform to Proton Guidelines.

Branch naming

Branch names must respect the pattern type/description-of-the-change.

Type must be one of the following:

  • chore for changes not related to the Kotlin source code, for example a change in the build config
  • doc for changes related to source code documentation, or external document, like the README
  • feat for a new feature for the app
  • fix for bug fixes
  • refactor for improving one or more unit of code, without impacting the behaviour of the app
  • test for everything related to test ( add a new test suite, add a new test into an already existing test suite or improve/modify the performance or the behaviour of an already existing test )

description of change must be a concise and meaningful description of what is expected by the change apported; words must be separated by a dash -

The whole name of the branch must be lower case.

Commit message

The template for a commit message is the following

<Title of the commit>

#comment <Description of the changes>
Affected: <List of affected classes or behaviours>

Title is required and must start with a capital letter.

#comment field is optional if the Title can exhaustively explain the changes, otherwise is required. Body of the comment must start with a capital letter.

Affected is optional and must be a comma separated list of the elements affected by the changes, it could be the name of a class or a behaviour like Encryption, Login flow, LoginActivity.kt

Code style and pattern

The code must conform the standards defined in the files config/CodeStyle.xml and config/detekt.xml.

CodeStyle.xml can be imported in the IDE ( Preferences -> Editor -> Code Style -> Import scheme for IntelliJ and Android Studio ).

Detekt reports can be generated with the command ./gradlew detekt. Check Detekt GitHub documentation for know how to download and configure the optional IDE plugin.

Copyright (c) 2020 Proton Technologies AG

More Repositories

1

WebClients

Monorepo hosting the proton web clients
TypeScript
4,315
star
2

ios-mail

Secure email that protects your privacy
Swift
1,439
star
3

proton-bridge

Proton Mail Bridge application
Go
1,137
star
4

gopenpgp

A high-level OpenPGP library
Go
1,018
star
5

proton-python-client

Python Proton client module
Python
343
star
6

gluon

An IMAP server library written in Go
Go
339
star
7

go-crypto

Fork of go/x/crypto, providing an up-to-date OpenPGP implementation
Go
323
star
8

react-components

List of React components for Proton web-apps
TypeScript
177
star
9

proton-mail

React web application to manage ProtonMail
TypeScript
172
star
10

android-mail

Proton Mail Android app
Kotlin
141
star
11

protoncore_android

Proton Core components for Android
Kotlin
129
star
12

design-system

Design system for new Proton project
SCSS
124
star
13

proton-calendar

Proton Calendar built with React.
TypeScript
120
star
14

proton-drive

TypeScript
115
star
15

proton-shared

Shared logic for Proton web-app
TypeScript
71
star
16

go-appdir

Minimalistic Go package to get application directories such as config and cache
Go
63
star
17

inbox-desktop

Desktop application for Mail and Calendar, made with Electron
63
star
18

proton-mail-settings

React web application to manage ProtonMail settings
TypeScript
52
star
19

ct-monitor

A monitoring tool for certificate transparency of ProtonMail's SSL/TLS certificates
Python
42
star
20

go-srp

Go
38
star
21

pmcrypto

TypeScript
37
star
22

go-proton-api

Proton API library used by Go-based clients and tools
Go
32
star
23

gosop

Stateless CLI for GopenPGP
Go
24
star
24

libsieve-php

libsieve-php is a library to manage and modify sieve (RFC5228) scripts. It contains a parser for the sieve language (including extensions) and a client for the managesieve protocol. It is written entirely in PHP 8+.
PHP
21
star
25

mutex-browser

Acquire a mutex in the browser through IndexedDB or cookies
TypeScript
19
star
26

releaser

A release note generator that reads and parses git commits and retrieves issue links from GitHub.
JavaScript
16
star
27

go-mime

Go
15
star
28

encrypted-search

Encrypted search functionality for the browser
JavaScript
14
star
29

proton-account

Proton account settings
TypeScript
13
star
30

sieve.js

Javascript library to wrap sieve configuration
JavaScript
13
star
31

protoncore_ios

Swift
11
star
32

cpp-openpgp

C++
10
star
33

proton-pack

Command to run a dev-server, build etc. with OpenPGP. On top of webpack.
JavaScript
10
star
34

proton-bundler

CLI tools to bundle Proton web clients for deploys
JavaScript
9
star
35

apple-fusion

fusion is a lightweight and easy-to-use UI testing framework built on top of Apple XCTest that supports testing on iOS and macOS platforms. Developed with readability and reliability in mind.
Swift
9
star
36

bip39

JavaScript implementation of Bitcoin BIP39
TypeScript
8
star
37

componentGenerator

CLI to create new components for the Front-End @ ProtonMail.
JavaScript
7
star
38

interval-tree

Red-black interval tree
TypeScript
7
star
39

php-coding-standard

ProtonLabs Coding Standard for PHP_CodeSniffer (extending PER coding style)
PHP
7
star
40

pm-srp

ProtonMail SRP and auth library
JavaScript
7
star
41

source-map-parser

Command line utility to parse js source maps with with node.js
JavaScript
6
star
42

haproxy-health-check

HAProxy Health Check for EXABGP
Python
6
star
43

pt-formgenerator

Html form generator library
JavaScript
6
star
44

account

JavaScript
6
star
45

go-rfc5322

An RFC5322 address/date parser written in Go
Go
6
star
46

proton-translations

6
star
47

go-ecvrf

Golang implementation of ECVRF-EDWARDS25519-SHA512-TAI, a verifiable random function described in draft-irtf-cfrg-vrf-10.
Go
5
star
48

protonmail.github.io

HTML
5
star
49

therecipe_qt

Go
5
star
50

proton-parking

Gatsby website for parking domains
TypeScript
4
star
51

webcrypto-spec

Specification for extension of webcrypto api
HTML
4
star
52

ios-networking

shared networking framworks
Swift
4
star
53

android-fusion

Android Fusion is a extensible lightweight Android instrumented test framework that combines Espresso, UI Automator and Compose Ui Test into one easy-to-use API with the clear syntax, at the same time keeping the native Android frameworks APIs unchanged.
Kotlin
4
star
54

proton-i18n

CLI to manage translations for client apps
JavaScript
3
star
55

proton-lint

Modern eslint config for a more civilized age
JavaScript
3
star
56

fe-proxy

A simple proxy server that redirects to different urls
JavaScript
3
star
57

Illuminate-Foundation

Illuminate Foundation Mirror
PHP
2
star
58

opendkim

This is a fork of https://sourceforge.net/p/opendkim/git/ci/master/tree/
C
2
star
59

logging

go logging
Go
2
star
60

openpgp-interop-test-analyzer

Python scripts to analyze results from the Openpgp interoperability test suite
Python
2
star
61

danger-random_reviewers

Ruby
1
star
62

u2f

JavaScript
1
star
63

react-storybook

Isolated React components from https://github.com/ProtonMail/react-components
JavaScript
1
star
64

key-transparency-web-client

TypeScript
1
star
65

x509-sign

Simple endpoint to sign ASN1 strings
PHP
1
star
66

openpgp-interop-test-docker

Docker image to run the OpenPGP interoperability test suite
Dockerfile
1
star
67

gomobile-build-tool

Go
1
star
68

therecipe_env_darwin_arm64_513

C++
1
star
69

pm-key-transparency-go-client

Go
1
star
70

proton-mobile-test

HTML
1
star