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
6023 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 612aa09071 Enable thread view in demo #445
2023-11-27 02:33:43 +01:00
.docker Enhancement (docker): Add more php extensions 2023-11-24 12:31:31 +00:00
.github Enhancement (ci): Use separate workflow for PR docker builds 2023-11-23 22:44:01 +00:00
build Nextcloud prevent serving precompressed files due to too many setups that fail 2023-02-01 10:22:46 +01:00
cli Drop application.ini for Docker #965 2023-11-21 21:10:33 +01:00
data Added README to /data/ folder 2020-11-03 16:22:26 +01:00
dev Extend example extension code with more details 2023-11-27 01:51:23 +01:00
examples Added some IMAP connection examples 2023-11-22 18:18:29 +01:00
fail2ban Bugfix: wrong fail2ban instruction 2021-03-23 22:04:27 +01:00
integrations v2.29.4 2023-11-21 23:49:16 +01:00
plugins Enable thread view in demo #445 2023-11-27 02:33:43 +01:00
snappymail/v/0.0.0 Resolve Add a "Move to" button inside message view #1295 2023-11-26 18:06:19 +01:00
tasks Update and cleanup npm 2023-02-24 12:27:50 +01:00
test Resolve #695 2022-11-23 16:26:26 +01:00
vendors More in line with Squire v2.2.5 2023-11-26 02:47:40 +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
.dockerignore Enhancement: Add Docker Hub image (#965) 2023-11-20 15:01:26 +01: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 v2.25.1 2023-01-30 15:49:58 +01:00
.gitmodules OpenPGP.js use clone https://github.com/the-djmaze/openpgpjs 2022-01-31 09:38:33 +01:00
.htaccess Set X-Frame-Options: DENY when frame_ancestors is empty 2023-02-21 19:15:21 +01: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 Move brotli and gzip compress option to application.ini 2023-02-23 08:39:40 +01:00
CHANGELOG.md Update changelog 2023-11-21 23:54:42 +01:00
CODE_OF_CONDUCT.md Updated Code of Conduct 2020-09-24 20:04:31 +02:00
CONTRIBUTING.md Resolve #891 and other index cache issues 2023-02-03 09:20:42 +01:00
docker-compose.yml Fix (development): Fix self-signed certs verification in docker-compose.yml 2023-11-24 10:47:32 +00:00
gulpfile.js Move "assets" to proper location in snappymail/v/0.0.0/static/ 2023-02-02 17:19:06 +01: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.29.4 2023-11-21 23:49:16 +01:00
README.md Enhancement (ci): Use separate workflow for PR docker builds 2023-11-23 22:44:01 +00:00
release.php move release.php to cli/release.php 2023-01-03 13:20:27 +01: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 Enhancement: Add Docker Hub image (#965) 2023-11-20 15:01:26 +01:00

README.md


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 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 - 2023 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
  • 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
  • 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 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
  • 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 80.124
app.js 4.207.787 407.460
boot.js 868.735 4.142
libs.js 658.812 192.239
sieve.js 0 85.141
polyfills.js 334.608 0
serviceworker.js 0 285
TOTAL 8.240.095 769.391
js/min/* RainLoop Snappy RL gzip SM gzip RL brotli SM brotli
admin.min.js 256.831 39.273 73.606 13.136 60.877 11.760
app.min.js 515.367 186.288 139.456 62.975 110.485 54.194
boot.min.js 84.659 2.084 26.998 1.202 23.643 1.003
libs.min.js 584.772 92.375 180.901 34.331 155.182 30.746
sieve.min.js 0 41.399 0 10.394 0 9.356
polyfills.min.js 32.837 0 11.406 0 10.175 0
TOTAL user 1.217.635 280.747 358.761 98.508 299.485 85.943
TOTAL user+sieve 1.217.635 322.146 358.761 108.902 299.485 95.299
TOTAL admin 959.099 133.732 292.911 48.669 249.877 43.509

For a user it is around 72% 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.569 46.946 17.645 15.111
app.min.css 274.947 67.927 39.647 15.528 13.541
boot.css 1.326 664 545
boot.min.css 1.071 590 474
admin.css 30.645 7.024 6.117
admin.min.css 24.746 6.346 5.608

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 541.176 102.388 168.266 84.241 138.278
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).

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