Code Monkey home page Code Monkey logo

cozy-emails's Introduction

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.

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

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

Run it with:

node server.js

Each modification of the server requires a new build, here is how to run a build:

cake build

Each modification of the client requires a specific build too.

cd client
brunch watch

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

Frontend

Tests suite is based on CasperJS. Tests data are loaded by cozy-fixtures. So, prior to run it, you need to install additional tools:

sudo apt-get install phantomjs
sudo npm install casperjs -g # version >= 1.1 is required.
sudo npm install cozy-fixtures -g

npm run fixtures

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

coffee server.coffee

Then you can run the client's tests:

npm run test:client

Backend

Build Status

Running tests requires a Vagrant. Tests load a Dovecot instance in a Vagrant virtual machine.

Once done, type the following command into the Cozy Emails folder:

cake tests

If you want to add mails to the test suite, type the following lines.

cd node_modules/dovecot-testing
npm link
dovecot-testing import

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.

cozy-emails's People

Contributors

aenario avatar benibur avatar clochix avatar cylwin avatar felix-lambert avatar frankrousseau avatar jsilvestre avatar kelukelu avatar m4dz avatar poupotte avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.