snappymail/README.md

197 lines
7.6 KiB
Markdown
Raw Normal View History

<div align="center">
<a href="https://github.com/the-djmaze/snappymail">
<img width="200" heigth="200" src="https://snappymail.eu/static/img/logo-256x256.png">
</a>
<br>
<h1>SnappyMail</h1>
<br>
<p>
Simple, modern, lightweight &amp; fast web-based email client.
</p>
<p>
The drastically upgraded &amp; secured fork of <a href="https://github.com/RainLoop/rainloop-webmail">RainLoop Webmail Community edition</a>.
</p>
<p>
2020-09-26 18:25:57 +08:00
We thank the RainLoop Team for making a great PHP 5 product that was good in the past.
</p>
<p>
Up to date system requirements, snappy performance, simple installation and upgrade, no database required
- all these make SnappyMail a good choice.
</p>
<h2></h2>
<br>
</div>
For more information about the product, check [snappymail.eu](https://snappymail.eu/).
Information about installing the product, check the [wiki page](https://github.com/the-djmaze/snappymail/wiki/Installation-instructions).
And don't forget to read the [RainLoop documentation](https://www.rainloop.net/docs/).
## License
**SnappyMail** is released under
**GNU AFFERO GENERAL PUBLIC LICENSE Version 3 (AGPL)**.
http://www.gnu.org/licenses/agpl-3.0.html
2021-01-22 00:37:41 +08:00
Copyright (c) 2020 - 2021 SnappyMail
Copyright (c) 2013 - 2021 RainLoop
## Modifications
This fork of RainLoop has the following changes:
2020-03-13 22:36:48 +08:00
* Privacy/GDPR friendly (no: Social, Gravatar, Facebook, Google, Twitter, DropBox, OwnCloud, X-Mailer)
* Admin uses password_hash/password_verify
2020-07-15 20:45:11 +08:00
* Auth failed attempts written to syslog
2020-07-29 17:29:59 +08:00
* Added Fail2ban instructions
* ES2015
* PHP 7.3+ required
* PHP mbstring extension required
2020-03-13 22:36:48 +08:00
* PHP replaced pclZip with ZipArchive
* PHP yaml extension else use the old Spyc
2020-07-15 20:45:11 +08:00
* Removed BackwardCapability (class \RainLoop\Account)
* Removed ChangePassword (plugins won't work)
* 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
2020-07-27 23:40:00 +08:00
* Ongoing removal of old JavaScript code (things are native these days)
2020-09-13 20:13:16 +08:00
* Added modified [Squire](https://github.com/neilj/Squire) HTML editor as replacement for CKEditor
* Split Admin specific JavaScript code from User code
2020-10-29 00:12:33 +08:00
* JSON reviver
* Better memory garbage collection management
* Added serviceworker for Notifications
2021-01-22 00:37:41 +08:00
* Added advanced Sieve scripts editor
* Slimmed down language files
* Replaced webpack with rollup
2021-02-17 23:31:29 +08:00
* No user-agent detection (use device width)
2020-07-15 20:45:11 +08:00
2020-07-27 23:40:00 +08:00
### Removal of old JavaScript
This fork uses downsized/simplified versions of scripts and has no support for Internet Explorer.
2020-07-28 17:23:06 +08:00
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().
2020-07-24 02:50:20 +08:00
* Added dev/prototype.js for some additional features
2020-09-03 22:34:23 +08:00
* boot.js without webpack overhead
* Modified Jua.js to be without jQuery
* Replaced ProgressJS with simple native dropin
2020-08-31 22:33:40 +08:00
* Replaced Autolinker with simple https/email detection
* Replaced ifvisible.js with simple drop-in replacement
* 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
* Removed pikaday
* Removed underscore
* Removed polyfills
* Removed Modernizr
* Removed nanoscroll
2020-09-22 00:54:41 +08:00
* Removed lightgallery
* Removed jQuery
* Removed jquery-ui
* Removed jquery-scrollstop
* Removed jquery-mousewheel
* Removed matchmedia-polyfill
* Removed momentjs (use Intl)
2020-08-13 19:16:08 +08:00
* Removed opentip (use CSS)
* Removed non-community (aka Prem/Premium/License) code
2021-01-27 19:02:37 +08:00
RainLoop 1.15 vs SnappyMail
|js/* |RainLoop |Snappy |
|--------------- |--------: |--------: |
|admin.js |2.158.025 | 110.918 |
|app.js |4.215.733 | 519.708 |
2021-02-17 23:31:29 +08:00
|boot.js | 672.433 | 4.726 |
|libs.js | 647.679 | 227.110 |
2021-01-27 19:02:37 +08:00
|polyfills.js | 325.908 | 0 |
|serviceworker.js | 0 | 285 |
2021-02-17 23:31:29 +08:00
|TOTAL |8.019.778 | 875.589 |
2021-01-27 19:02:37 +08:00
|js/min/* |RainLoop |Snappy |RL gzip |SM gzip |RL brotli |SM brotli |
|--------------- |--------: |--------: |------: |------: |--------: |--------: |
|admin.min.js | 255.514 | 56.127 | 73.899 | 16.069 | 60.674 | 14.274 |
|app.min.js | 516.000 | 253.025 |140.430 | 73.063 |110.657 | 61.430 |
2021-02-17 23:31:29 +08:00
|boot.min.js | 66.456 | 2.525 | 22.553 | 1.391 | 20.043 | 1.201 |
|libs.min.js | 574.626 | 119.817 |177.280 | 43.974 |151.855 | 39.127 |
2021-01-27 19:02:37 +08:00
|polyfills.min.js | 32.608 | 0 | 11.315 | 0 | 10.072 | 0 |
|TOTAL |1.445.204 | 431.494 |425.477 |134.497 |353.301 |116.032 |
|TOTAL (no admin) |1.189.690 | 375.474 |351.061 |118.428 |292.627 |101.758 |
2020-08-31 22:33:40 +08:00
For a user its around 65% smaller and faster than traditional RainLoop.
2020-08-31 22:33:40 +08:00
### CSS changes
2021-01-27 19:02:37 +08:00
* Solve jQuery removed "features" with native css code
* Themes work in mobile mode
* Bugfix invalid/conflicting css rules
2021-02-17 23:31:29 +08:00
* Use flexbox
* Split app.css to have seperate admin.css
2021-02-17 23:31:29 +08:00
* Remove oldschool 'float'
* Remove unused css
2020-08-31 22:33:40 +08:00
* 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 | 115.927 | 46,959 | 19.501 | 16.699 |
|app.min.css | 274.791 | 96.071 | 39.618 | 17.475 | 15.295 |
|boot.css | | 2.066 | | 795 | 630 |
|boot.min.css | | 1.696 | | 707 | 555 |
|admin.css | | 53.966 | | 10.376 | 9.070 |
|admin.min.css | | 43.137 | | 9.126 | 8.133 |
### Squire vs CKEditor
The [Squire](https://github.com/neilj/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).
2020-09-22 21:24:45 +08:00
To use the old CKEditor, you must enable it in /data/\_data\_/\_default\_/configs/application.ini
in the [labs] section add/edit: `use_ck_html_editor = On`
2020-07-15 20:45:11 +08:00
### PHP73 branch
There's a RainLoop 1.14.0 branch with only the PHP 7.3 changes at
https://github.com/the-djmaze/snappymail/tree/php73