snappymail/README.md
2021-04-09 13:27:24 +02:00

7.5 KiB


SnappyMail


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 RainLoop documentation.

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 - 2021 SnappyMail Copyright (c) 2013 - 2021 RainLoop

Modifications

This fork of RainLoop has the following changes:

  • Privacy/GDPR friendly (no: Social, Gravatar, Facebook, Google, Twitter, DropBox, OwnCloud, X-Mailer)
  • Admin uses password_hash/password_verify
  • Auth failed attempts written to syslog
  • Added Fail2ban instructions
  • ES2015
  • PHP 7.3+ required
  • PHP mbstring extension required
  • PHP replaced pclZip with PharData and ZipArchive
  • PHP yaml extension else use the old Spyc
  • 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 OAuth support
  • Removed POP3 support
  • Removed background video support
  • Removed Sentry (Application Monitoring and Error Tracking Software)
  • Replaced gulp-uglify with gulp-terser
  • CRLF => LF line endings
  • Embed boot.js and boot.css into index.html
  • Ongoing removal of old JavaScript code (things are native these days)
  • Added modified Squire HTML editor as replacement for CKEditor
  • Split Admin 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

Removal of old JavaScript

This fork uses downsized/simplified versions of scripts and has no support for Internet Explorer.

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

Things might work in Edge 18, Firefox 50-62 and Chrome 54-68 due to one polyfill for array.flat().

  • Added dev/prototype.js for some additional features
  • boot.js without webpack overhead
  • Modified Jua.js to be without jQuery
  • Replaced ProgressJS with simple native dropin
  • Replaced Autolinker with simple https/email detection
  • Replaced ifvisible.js with simple drop-in replacement
  • Replaced momentToNode with proper HTML5
  • 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
  • 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

RainLoop 1.15 vs SnappyMail

js/* RainLoop Snappy
admin.js 2.158.025 95.529
app.js 4.215.733 467.616
boot.js 672.433 4.554
libs.js 647.679 227.911
polyfills.js 325.908 0
serviceworker.js 0 285
TOTAL 8.019.778 795.895
js/min/* RainLoop Snappy RL gzip SM gzip RL brotli SM brotli
admin.min.js 255.514 50.607 73.899 14.944 60.674 13.364
app.min.js 516.000 240.896 140.430 70.621 110.657 59.521
boot.min.js 66.456 2.442 22.553 1.371 20.043 1.178
libs.min.js 574.626 115.854 177.280 42.809 151.855 38.140
polyfills.min.js 32.608 0 11.315 0 10.072 0
TOTAL 1.445.204 409.799 425.477 129.745 353.301 112.203
TOTAL (no admin) 1.189.690 359.192 351.061 114.801 292.627 98.839

For a user its around 66% 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
  • Split app.css to have seperate 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 vendors/bootstrap/less/breadcrumbs.less
  • Removed vendors/bootstrap/less/navbar.less
  • Removed vendors/bootstrap/less/popovers.less
  • Removed vendors/bootstrap/less/progress-bars.less
  • Removed vendors/bootstrap/less/scaffolding.less
  • Removed vendors/bootstrap/less/sprites.less
  • Removed vendors/bootstrap/less/tooltip.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.334 107.300 46,959 18.817 16.173
app.min.css 274.791 88.452 39.618 16.857 14.849
boot.css 2.066 913 742
boot.min.css 1.696 818 664
admin.css 46.393 9.237 8.073
admin.min.css 37.306 8.191 7.282

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?!?)
  • support BIDI (really needed?!?)
normal min gzip min gzip
squire 128.826 47.074 33.671 15.596
ckeditor ? 520.035 ? 155.916

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

To use the old CKEditor, you must install the plugin.