Skip to content

Latest commit

 

History

History
226 lines (189 loc) · 8.89 KB

README.md

File metadata and controls

226 lines (189 loc) · 8.89 KB
Raw

SnappyMail


github-actions docker-image-size

Simple, modern, lightweight & fast web-based email client.

The drastically upgraded & secured fork of RainLoop Webmail Community edition.

We thank the RainLoop Team for making a great PHP 5 product that was good in the past.

Up to date system requirements, snappy performance, simple installation and upgrade, no database required - all these make SnappyMail a good choice.


For more information about the product, check snappymail.eu.

Information about installing the product, check the wiki page.

And don't forget to read the whole Wiki.

License

SnappyMail is released under GNU AFFERO GENERAL PUBLIC LICENSE Version 3 (AGPL). http://www.gnu.org/licenses/agpl-3.0.html

Copyright (c) 2020 - 2024 SnappyMail Copyright (c) 2013 - 2022 RainLoop

Modifications

This fork of RainLoop has the following changes:

  • Privacy/GDPR friendly (no: Social, Gravatar, Facebook, Google, Twitter, DropBox, X-Mailer)
  • Admin uses password_hash/password_verify
  • Auth failed attempts written to syslog
  • Added Fail2ban instructions
  • ES2020
  • PHP 7.4+ required
  • PHP mbstring extension required
  • PHP replaced pclZip with PharData and ZipArchive
  • Dark mode
  • Added option to remove background/font colors from messages for real "dark mode"
  • Removed BackwardCapability (class \RainLoop\Account)
  • Removed ChangePassword (re-implemented as plugin)
  • Removed POP3 support
  • Removed background video support
  • Removed Sentry (Application Monitoring and Error Tracking Software)
  • Removed Spyc yaml
  • Removed OwnCloud
  • Replaced gulp-uglify with gulp-terser
  • CRLF => LF line endings
  • Embed boot.js and boot.css into index.html
  • Removal of old JavaScript code (things are native these days)
  • Added modified Squire HTML editor as replacement for CKEditor
  • Updated Sabre/VObject
  • Split Admin specific JavaScript code from User code
  • Split Sieve specific JavaScript code from User code
  • JSON reviver
  • Better memory garbage collection management
  • Added serviceworker for Notifications
  • Added advanced Sieve scripts editor
  • Slimmed down language files
  • Replaced webpack with rollup
  • No user-agent detection (use device width)
  • Added support to load plugins as .phar
  • Replaced old Sabre library
  • AddressBook Contacts support MySQL/MariaDB utf8mb4
  • Added Fetch Metadata Request Headers checks
  • Reduced excessive DOM size
  • Support Kolab groupware
  • Support many more IMAP RFC's
  • Support Sodium and OpenSSL for encryption
  • Much better PGP support

Supported browsers

This fork uses downsized/simplified versions of scripts and has no support for Internet Explorer nor Edge Legacy. Supported are:

  • Chrome 80+
  • Edge 80+
  • Firefox 78+
  • Opera 67+
  • Safari 13.1+

Removal of old JavaScript

The result is faster and smaller download code (good for mobile networks).

  • Added dev/prototype.js for some additional features
  • Modified Jua.js to be without jQuery
  • Replaced Autolinker with simple https/email detection
  • Replaced momentToNode with proper HTML5 <time>
  • Replaced resize listeners with ResizeObserver
  • Replaced bootstrap.js with native drop-in replacement
  • Replaced dev/Common/ClientStorageDriver/* with Web Storage Objects polyfill
  • Replaced *Ajax with *Fetch classes because we use the Fetch API, not jQuery.ajax
  • Replaced knockoutjs 3.4 with a modified 3.5.1
  • Replaced knockout-sortable with native HTML5 drag&drop
  • Replaced simplestatemanager with CSS @media
  • Replaced inputosaurus with own code
  • Replaced keymaster with own shortcuts handler
  • Replaced OpenPGP.js v2 with OpenPGP.js v5
  • Removed ifvisible.js
  • Removed pikaday
  • Removed underscore
  • Removed polyfills
  • Removed Modernizr
  • Removed nanoscroll
  • Removed lightgallery
  • Removed jQuery
  • Removed jquery-ui
  • Removed jquery-scrollstop
  • Removed jquery-mousewheel
  • Removed matchmedia-polyfill
  • Removed momentjs (use Intl)
  • Removed opentip (use CSS)
  • Removed non-community (aka Prem/Premium/License) code
  • Removed ProgressJS

RainLoop 1.17 vs SnappyMail

js/* RainLoop Snappy
admin.js 2.170.153 84.203
app.js 4.207.787 445.359
boot.js 868.735 4.343
libs.js 658.812 193.716
sieve.js 0 84.571
polyfills.js 334.608 0
serviceworker.js 0 285
TOTAL 8.240.095 812.477
js/min/* RainLoop Snappy RL gzip SM gzip RL brotli SM brotli
admin.min.js 256.831 41.256 73.606 13.940 60.877 12.493
app.min.js 515.367 201.270 139.456 68.096 110.485 58.078
boot.min.js 84.659 2.231 26.998 1.271 23.643 1.067
libs.min.js 584.772 92.365 180.901 34.487 155.182 30.830
sieve.min.js 0 41.288 0 10.327 0 9.318
polyfills.min.js 32.837 0 11.406 0 10.175 0
TOTAL user 1.217.635 295.866 358.761 103.854 299.485 89.975
TOTAL user+sieve 1.217.635 337.154 358.761 114.181 299.485 99.293
TOTAL admin 959.099 135.852 292.911 49.698 249.877 44.390

For a user it is around 68% smaller and faster than traditional RainLoop.

CSS changes

  • Solve jQuery removed "features" with native css code
  • Themes work in mobile mode
  • Bugfix invalid/conflicting css rules
  • Use flexbox
  • Use border-box
  • Split app.css to have separate admin.css
  • Remove oldschool 'float'
  • Remove unused css
  • Removed html.no-css
  • Removed dev/Styles/Cmd.less
  • Removed dev/Styles/Scroll.less
  • Removed Internet Explorer from normalize.css
  • Removed node_modules/opentip/css/opentip.css
  • Removed node_modules/pikaday/css/pikaday.css
  • Removed unused vendors/bootstrap/less/*
  • Removed vendors/jquery-nanoscroller/nanoscroller.css
  • Removed vendors/jquery-letterfx/jquery-letterfx.min.css
  • Removed vendors/Progress.js/minified/progressjs.min.css
  • Removed gulp-autoprefixer
css/* RainLoop Snappy RL gzip SM gzip SM brotli
app.css 340.331 84.691 46.946 17.693 15.157
app.min.css 274.947 68.052 39.647 15.589 13.610
boot.css 1.326 664 545
boot.min.css 1.071 590 474
admin.css 30.602 7.023 6.112
admin.min.css 24.717 6.346 5.586

PGP

RainLoop uses the old OpenPGP.js v2 SnappyMail v2.12 uses OpenPGP.js v5, GnuPG and Mailvelope. SnappyMail is able to use and generate ECDSA and EDDSA keys, where RainLoop does not.

Since SnappyMail tries to achieve the best mobile experience, it forked OpenPGP.js to strip it down.

OpenPGP RainLoop Snappy RL gzip SM gzip RL brotli SM brotli
openpgp.min.js 330.742 546.165 102.388 169.207 84.241 138.688
openpgp.worker 1.499 824 695

Squire vs CKEditor

The Squire implementation is not 100% compatible yet, but it shows the massive overhead of CKEditor.

Still TODO:

  • support for tables (really needed?!?)
normal min gzip min gzip
squire 122.321 41.906 31.867 14.330
ckeditor ? 520.035 ? 155.916

CKEditor including the 7 asset requests (css,language,plugins,icons) is 633.46 KB / 180.47 KB (gzip).