node package manager

cozy-emails

Cozy Emails

Cozy Emails lets you read and write your emails from your Cozy. The project is about to start, here are the main features we want to have:

  • Simple UI
  • Read/write emails
  • Multiple mailboxes
  • Attachments management (synced with Files!)

Install

We assume here that the Cozy platform is correctly installed on your server.

Graphically

You can simply install the Emails application via the app registry. Click on the Choose Your Apps button located on the right of your Cozy Home.

CLI

From the command line you can type this command:

$ cozy-monitor install emails

Contribution

You can contribute to the Cozy Emails in many ways:

Stories in Ready

Hack

Hacking the Emails app requires you setup a dev environment. Once it's done you can hack the emails just like it was your own app.

$ git clone https://github.com/cozy/cozy-emails.git
$ npm install
cd client
$ npm install

Development

Run it with:

$ npm run watch

The watch task starts 3 daemons:

  • the server one, running coffee-script server-side code through a nodemon process that reload the server part each time you make a change
  • a node-inspector process, that let you use the Chome/Chromium devtools applied to your node process and debug it directly in your browser
  • a brunch watcher which recompiles and reload through browser-sync your front-end app in your browser each time you make a change

Build

The build is a part of the publication process, and you'll probably never need it explicitly. If you want to build you app anyway (e.g. to deploy it in a sandboxed cozy for tests purposes), you can achieve a build by running:

$ npm run build

Please, do not push your local builds in your PR, as long as we make the build process when we release the app.

If you need to run the tests suite to your build:

$ npm run test:build

Naming conventions

We've adopted IMAP naming conventions, which means:

  • Account: bound to a provider like Gmail
  • Mailbox: equivalent to imap folder
  • Message: an email
  • Conversation: a thread of Message

Tests

A tests suite is available. You can run it with:

npm run test

Feel free to adapt/fix/add your own tests in your PR ;).

Frontend

Tests suite is based on CasperJS. Tests data are loaded by cozy-fixtures.

$ npm run fixtures

To run the client's tests, you need to start the server:

$ npm run watch:server

Then you can run the client's tests in another terminal:

$ npm run test:client

Backend

Build Status

Running tests requires a Vagrant. Tests load a Dovecot instance in a Vagrant virtual machine. Make sure your Vagrant box is running, then run:

$ npm run test:server

In order to run the tests, you must only have the Data System started. The tests wont pass if you already have an account in your data-system

Mail Loader

Mail loader test is based on the Dovecot Testing repository.

Icons

By Fontawesome. Main icon by Elegant Themes.

License

Cozy Emails is developed by Cozy Cloud and distributed under the AGPL v3 license.

What is Cozy?

Cozy Logo

Cozy is a platform that brings all your web services in the same private space. With it, your web apps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one profiles you.

Community

You can reach the Cozy Community by:

  • Chatting with us on IRC #cozycloud on irc.freenode.net
  • Posting on our Forum
  • Posting issues on the Github repos
  • Mentioning us on Twitter

Technical reference

You will find all relevant resources about Emails development under this section.

Javascript

Layout and styles

Useful resources

This section references RFC and resources to understand IMAP.