the-djmaze/snappymail
1
1
Fork 0
mirror of https://github.com/the-djmaze/snappymail.git synced 2024-11-10 17:13:38 +08:00
Code Issues Projects Releases Packages Wiki Activity
Simple, modern & fast web-based email client
3889 commits 9 branches 203 tags 79 MiB
PHP 70.7%
JavaScript 22%
HTML 3.3%
CSS 2.2%
Less 1.1%
Other 0.7%
Find a file
kouinkouin c6099f9863
feat(docker): use --build-arg=aarch64 to build for arm64
2022-05-13 15:37:51 +02:00
.docker feat(docker): use --build-arg=aarch64 to build for arm64 2022-05-13 15:37:51 +02:00
.github Drop github sponsoring due to required Stripe account. 2022-01-12 15:16:49 +01:00
assets PWA #264 Manifest does not have: 2022-03-15 16:02:58 +01:00
build Resolve #359 2022-04-30 21:04:41 +02:00
data Added README to /data/ folder 2020-11-03 16:22:26 +01:00
dev Small fix for changes of #248 2022-05-12 15:11:07 +02:00
fail2ban Bugfix: wrong fail2ban instruction 2021-03-23 22:04:27 +01:00
integrations v2.15.2 2022-05-12 15:52:40 +02:00
plugins Added example plugin how to use Kolab for contact suggestions 2022-05-13 00:49:25 +02:00
snappymail/v/0.0.0 Added example plugin how to use Kolab for contact suggestions 2022-05-13 00:49:25 +02:00
tasks Split Sieve/Filters code from app.js so that i can work on the new Sieve GUI 2022-03-11 10:26:25 +01:00
test Use SNAPPYMAIL_INCLUDE_AS_API and added SSO test 2022-01-10 16:10:56 +01:00
vendors Resolve #364 2022-05-12 15:10:24 +02: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 OpenPGP.js v5.2.1 2022-03-24 13:43:38 +01: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
CODE_OF_CONDUCT.md Updated Code of Conduct 2020-09-24 20:04:31 +02:00
CONTRIBUTING.md v2.7.0 2021-09-01 12:21:08 +02:00
docker-compose.yml Add better Docker development and prod support 2020-11-26 15:14:51 +01:00
gulpfile.js Found the round npm module to get rollup working in gulp 2021-02-02 13:54:48 +01:00
index.php Improved app booting 2021-12-23 16:04:40 +01:00
jsconfig.json Rename basefolder 'rainloop' to 'snappymail' 2020-10-15 16:21:52 +02:00
LICENSE Change license to AGPL 2015-05-05 00:05:06 +04:00
Makefile Improve getFoldersFromResult fix 2021-05-05 23:46:51 +03:00
package.json v2.15.2 2022-05-12 15:52:40 +02:00
README.md v2.15.2 2022-05-12 15:52:40 +02:00
release.php Generate core.json for #318 2022-04-13 23:52:21 +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 - 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
  • ES2018
  • PHP 7.3+ 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
  • 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 69+
  • Edge 79+
  • Firefox 78+
  • Opera 56+
  • Safari 12+

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 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
  • 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.15 vs SnappyMail

js/* RainLoop Snappy
admin.js 2.158.025 80.414
app.js 4.215.733 404.996
boot.js 672.433 2.050
libs.js 647.679 197.164
sieve.js 0 86.564
polyfills.js 325.908 0
serviceworker.js 0 285
TOTAL 8.019.778 771.473
js/min/* RainLoop Snappy RL gzip SM gzip RL brotli SM brotli
admin.min.js 255.514 40.249 73.899 13.380 60.674 11.968
app.min.js 516.000 191.767 140.430 61.896 110.657 53.097
boot.min.js 66.456 1.252 22.553 778 20.043 628
libs.min.js 574.626 95.158 177.280 35.159 151.855 31.465
sieve.min.js 0 42.182 0 10.555 0 9.510
polyfills.min.js 32.608 0 11.315 0 10.072 0
TOTAL user 1.189.690 288.177 351.061 97.833 292.627 85.190
TOTAL user+sieve 1.189.690 330.359 351.061 108.388 292.627 94.700
TOTAL admin 929.204 136.659 285.047 49.317 242.644 44.061

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.334 80.866 46.959 16.740 14.414
app.min.css 274.791 64.994 39.618 14.821 13.065
boot.css 1.326 664 545
boot.min.css 1.071 590 474
admin.css 30.051 6.815 5.910
admin.min.css 24.163 6.187 5.437

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.244 102.388 166.997 84.241 137.184
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.