the-djmaze/snappymail
1
1
Fork 0
mirror of https://github.com/the-djmaze/snappymail.git synced 2024-09-20 15:45:55 +08:00
Code Issues Packages Projects Releases Wiki Activity
Simple, modern & fast web-based email client
4656 commits 8 branches 201 tags 78 MiB
PHP 70.6%
JavaScript 22.1%
HTML 3.3%
CSS 2.2%
Less 1.1%
Other 0.7%
Go to file
the-djmaze 74da439b08 Merge branch 'master' of github.com:the-djmaze/snappymail
2022-11-13 10:20:37 +01:00
.docker v2.21.0 2022-11-11 17:50:18 +01:00
.github Road to the MIT 2022-08-31 19:20:47 +00:00
assets Resolve #643 2022-11-08 20:51:05 +01:00
build v2.20.3 2022-11-07 14:19:16 +01:00
cli Forgot one change for #229 and #544 2022-10-08 23:59:56 +02:00
data Added README to /data/ folder 2020-11-03 16:22:26 +01:00
dev v2.21.0 2022-11-11 17:50:18 +01:00
fail2ban Bugfix: wrong fail2ban instruction 2021-03-23 22:04:27 +01:00
integrations Resolve #666 2022-11-13 10:20:20 +01:00
plugins Add more info to plugins README 2022-11-11 17:22:49 +01:00
snappymail/v/0.0.0 update Chinese translation 2022-11-12 11:52:57 +08:00
tasks Drop ifvisible as it was only used for Prefetch and that feature was removed in v2.17 2022-10-10 10:53:04 +02:00
test Use SNAPPYMAIL_INCLUDE_AS_API and added SSO test 2022-01-10 16:10:56 +01:00
vendors Also theme menu border color 2022-11-04 15:54:26 +01:00
.browserslistrc Bump supported browserlist to cleanup CSS 2020-07-30 12:23:11 +02:00
.cmds Add github action 2021-01-16 17:51:14 +03:00
.editorconfig Fixing indentation 2020-11-10 11:52:21 +01:00
.eslintignore Add prettier 2019-07-04 22:09:27 +03:00
.eslintrc.js Drop ifvisible as it was only used for Prefetch and that feature was removed in v2.17 2022-10-10 10:53:04 +02:00
.gitignore chore(git): ignore *.zip resulted from release.php 2022-05-13 15:30:53 +02:00
.gitmodules OpenPGP.js use clone https://github.com/the-djmaze/openpgpjs 2022-01-31 09:38:33 +01:00
.htaccess Remove duplicate HSTS header on Apache if mod_headers is loaded 2022-04-19 23:09:20 +02:00
.prettierignore Add prettier 2019-07-04 22:09:27 +03:00
.prettierrc Add prettier 2019-07-04 22:09:27 +03:00
_include.php simplify custom include.php 2021-12-24 01:12:27 +01:00
CHANGELOG.md v2.21.0 2022-11-11 17:50:18 +01:00
CODE_OF_CONDUCT.md Updated Code of Conduct 2020-09-24 20:04:31 +02:00
CONTRIBUTING.md Road to the MIT 2022-08-31 19:20:47 +00:00
docker-compose.yml Add better Docker development and prod support 2020-11-26 15:14:51 +01:00
gulpfile.js Merge remote-tracking branch 'upstream/master' RainLoop v1.17 2022-09-01 00:24:33 +02:00
index.php Force PHP opcache_invalidate due to upgrade error reports "Missing version directory" 2022-11-01 10:14:33 +01:00
jsconfig.json Rename basefolder 'rainloop' to 'snappymail' 2020-10-15 16:21:52 +02:00
LICENSE Revert RainLoop merge that caused MIT vs AGPL 2022-09-01 21:16:52 +02:00
Makefile Road to the MIT 2022-08-31 19:20:47 +00:00
package.json v2.21.0 2022-11-11 17:50:18 +01:00
README.md v2.21.0 2022-11-11 17:50:18 +01:00
release.php Create Nextcloud release builder for #96 2022-10-12 10:33:25 +02:00
rollup.config.js Found the round npm module to get rollup working in gulp 2021-02-02 13:54:48 +01:00
SECURITY.md Just make email address clickable 2022-03-04 15:23:20 +01:00
template.env Add better Docker development and prod support 2020-11-26 15:14:51 +01:00
yarn.lock v2.12.0-pr1 2022-02-07 12:29:19 +01:00

README.md


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 - 2022 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, OwnCloud, X-Mailer)
  • Admin uses password_hash/password_verify
  • Auth failed attempts written to syslog
  • Added Fail2ban instructions
  • ES2018
  • 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
  • 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
  • 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 IMAP RFC 2971 ID extension
  • Support IMAP RFC 5258 LIST-EXTENDED
  • Support IMAP RFC 5464 METADATA
  • Support IMAP RFC 5819 LIST-STATUS
  • Support IMAP RFC 7628 SASL OAUTHBEARER aka XOAUTH2
  • Support IMAP4rev2 RFC 9051
  • 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
  • boot.js without webpack overhead
  • 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
  • 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 82.515
app.js 4.207.787 406.190
boot.js 868.735 2.031
libs.js 658.812 192.965
sieve.js 0 86.121
polyfills.js 334.608 0
serviceworker.js 0 285
TOTAL 8.240.095 770.107
js/min/* RainLoop Snappy RL gzip SM gzip RL brotli SM brotli
admin.min.js 256.831 40.856 73.606 13.566 60.877 12.142
app.min.js 515.367 188.137 139.456 62.532 110.485 53.603
boot.min.js 84.659 1.251 26.998 773 23.643 627
libs.min.js 584.772 92.055 180.901 34.113 155.182 30.641
sieve.min.js 0 41.926 0 10.484 0 9.451
polyfills.min.js 32.837 0 11.406 0 10.175 0
TOTAL user 1.217.635 281.443 358.761 97.418 299.485 84.871
TOTAL user+sieve 1.217.635 323.369 358.761 107.902 299.485 94.322
TOTAL admin 959.099 134.162 292.911 48.452 249.877 43.410

For a user its around 70% 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 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 83.746 46.946 17.262 14.779
app.min.css 274.947 67.483 39.647 15.311 13.365
boot.css 1.326 664 545
boot.min.css 1.071 590 474
admin.css 30.816 6.939 6.028
admin.min.css 24.969 6.300 5.531

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 539.257 102.388 166.998 84.241 137.186
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?!?)
  • support BIDI (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).

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