README.md

iOS-mail

Introduction

iOS-mail — ProtonMail iOS client app

The app is intended for all users of the ProtonMail service. Whether they are paid or free, they can compose and read emails, manage folders and labels, manage some account settings and create a new account. The app supports iOS versions 11 and above.

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

Table of Contents

• Introduction
• License
• Architecture
• Dependencies
  • Internal
  • Third Party
• Content Explanation
• Setup
• Live version
• Articles
• Our Team
• TODO

Architecture

MVVM-C with services. Model-View-ViewModel architecture, plus the Coordinator pattern.

Dependencies

Internal

• gopenpgp
• OpenPGP
• VCard
• go-srp

Third Party

Acknowledgements

Content Explanation

• OpenPGP
• Keymaker
• ProtonMail
• PushService
• Share
• Siri
• Scripts
• Trust Model
• Local Data Protection

Setup

1. Have macOS up to date and install Xcode 13.2.1
2. We are using Mint as our package manager, If you don't have it, you can install it via Homebrew by brew bundle --file="ProtonMail/Brewfile" --no-upgrade then run mint bootstrap to install dependecies
3. DOMPurify and Cocoapods are pre-downloaded. We are using git submodules for tracking DOMPurifier, so after cloning you have to run git submodule init and git submodule update to fetch it. Theory here: https://git-scm.com/book/en/v2/Git-Tools-Submodules
4. We are using XcodeGen to generate Xcode project, sh ProtonMail/xcodeGenHelper.sh
5. Open ProtonMail/ProtonMail.xcworkspace and update project settings to use your own provisioning profile.
6. Run the app.

Live version

Current live version 4.2.2

• Apple Store

Articles

• Open sourcing
• Security model

Our Team

• Anson
• Mustapha
• Steven
• Jacek
• Xavi