Neuron Powered Motorization
Miss any of our Open RFC calls?Watch the recordings here! »

raven-webmail

0.0.10-2 • Public • Published

Raven Webmail

A webmail for wildduck mailserver

Raven Webmail


Install

npm i -g raven-webmail

Configure

Create a default config file

  • config file is auto-documented
raven create-config [-o --output="./config.toml"]

Run

raven start [-c --config="./config.toml"]

Localization

User locale is detected from Accept-Language http header
Human generated locales
  • ✓ en, English (default) - full
  • ✓ es, Spanish - full
Machine generated locales (ISO codes)

af, am, ar, az, be, bg, bn, bs, ca, ceb, co, cs, cy, da, de, el, eo, et, eu, fa, fi, fr, fy, ga, gd, gl, gu, ha, haw, hi, hmn, hr, ht, hu, hy, id, ig, is, it, iw, ja, jw, ka, kk, km, kn, ko, ku, ky, la, lb, lo, lt, lv, mg, mi, mk, ml, mn, mr, ms, mt, my, ne, nl, no, ny, or, pa, pl, ps, pt, ro, ru, rw, sd, si, sk, sl, sm, sn, so, sq, sr, st, su, sv, sw, ta, te, tg, th, tk, tl, tr, tt, ug, uk, ur, uz, vi, xh, yi, yo, zh, zh-TW, zu

Add custom locales

Uncomment the "custom_locale_dirs" entry in the config file and run this command to generate a default locale file that you can edit

Note that until we reach version 1 locale entries may change between versions

Locales will be checked at startup and preety warnings will be logged if any

Custom locales will override existing ones for the same ISO code

raven create-locale [-c --config="./config.toml"] --code ISOCode

Please if you create a locale for your language make a PR or an issue and I will add it to the available locales


TODO

  • Better page titles
  • Localization
  • Create / Remove folders
  • Create / Remove filters
  • Choose sender address (currently uses user default address)

Development

./src contains server side and cli typescript code that get compiled to ./dist

note that server code gets compiled with ttsc (typescript with transformers) instead of tsc to get runtime type checking in the io between client and server

./client contains the webmail single-page-app made with svelte

./client is a subpackage with its own devDependencies (no runtime dependencies needed)

git clone https://github.com/ramiroaisen/raven-webmail
cd raven-webmail
 
# install server dependencies 
npm i
 
# install client dependencies 
cd client && npm i
 
# build client 
cd client && npm run build
 
# starts client autobuild 
cd client && npm run dev
 
# build server 
npm run build
 
# start server autobuild 
npm run dev
 
# create default config file in ./config.toml 
node raven create-config
 
# edit settings, then run the app 
node raven start

If you find a bug or have a feature request start an issue in this repo

Are you using raven-webmail in production? Let me know!

Install

npm i raven-webmail

DownloadsWeekly Downloads

6

Version

0.0.10-2

License

ISC

Unpacked Size

4.87 MB

Total Files

811

Last publish

Collaborators

  • avatar