<commit_before>Poodle
======

Experimental email client with social features

Poodle produces and consume messages that contained structured JSON data. This
enables rich features that email normally lacks, such as likes, and editing
messages after they have been sent.


Prerequisites
-------------

Poodle reads and composes messages. Currently it relies on external programs to
actually fetch and send messages. Because of these dependencies, Poodle works
well on Linux and OS X, but is not likely to work on Windows.

You will need three additional pieces of software:

- Something to download email to the local filesystem. Must use Maildir format.
The author uses [offlineimap][]. There is another option called isync/mbsync.

- [notmuch][], which indexes mail stored in Maildir format.

- msmtp to send mail

It is handy to have offlineimap (or equivalent) running in the background all
the time. Notmuch does not run in the background - but you do need to run `$
notmuch new` whenever you get new mail to add the new messages to the index.
You can run that manually, or get offlineimap to run it whenever it syncs
changes.

All of these programs are probably available in your favorite package manager.

A good source of information for configuration is the Arch Wiki:

- https://wiki.archlinux.org/index.php/OfflineIMAP
- https://wiki.archlinux.org/index.php/Notmuch
- https://wiki.archlinux.org/index.php/Msmtp

[offlineimap]: https://github.com/OfflineIMAP/offlineimap/blob/master/README.md
[notmuch]: http://notmuchmail.org/

To build Poodle you will also need [Node.js and npm][npm].

[npm]: https://docs.npmjs.com/getting-started/installing-node


Running
-------

From the project directory, run:

    $ npm install && npm start


License
-------

Copyright 2015 <NAME>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,<commit_msg>Adds note to readme regarding setting for sent mail location<commit_after>Poodle
======

Experimental email client with social features

Poodle produces and consume messages that contained structured JSON data. This
enables rich features that email normally lacks, such as likes, and editing
messages after they have been sent.


Prerequisites
-------------

Poodle reads and composes messages. Currently it relies on external programs to
actually fetch and send messages. Because of these dependencies, Poodle works
well on Linux and OS X, but is not likely to work on Windows.

You will need three additional pieces of software:

- Something to download email to the local filesystem. Must use Maildir format.
The author uses [offlineimap][]. There is another option called isync/mbsync.

- [notmuch][], which indexes mail stored in Maildir format.

- msmtp to send mail

It is handy to have offlineimap (or equivalent) running in the background all
the time. Notmuch does not run in the background - but you do need to run `$
notmuch new` whenever you get new mail to add the new messages to the index.
You can run that manually, or get offlineimap to run it whenever it syncs
changes.

All of these programs are probably available in your favorite package manager.

A good source of information for configuration is the Arch Wiki:

- https://wiki.archlinux.org/index.php/OfflineIMAP
- https://wiki.archlinux.org/index.php/Notmuch
- https://wiki.archlinux.org/index.php/Msmtp

[offlineimap]: https://github.com/OfflineIMAP/offlineimap/blob/master/README.md
[notmuch]: http://notmuchmail.org/

To build Poodle you will also need [Node.js and npm][npm].

[npm]: https://docs.npmjs.com/getting-started/installing-node


Running
-------

From the project directory, run:

    $ npm install && npm start


Configuring
-----------

In addition to configuring the external utilities,
you will need to enter some details in the Settings view
(accessed via the menu button in the upper-left of the Activity Stream view).
The somewhat complicated detail here is that you need to specify a directory
for sent mail that is an existing directory in your maildir.
That is, it needs to match up with an existing IMAP folder.

The sent mail directory setting is not required.
But if you do not set it, when you send messages you will not see updates in
the UI until you do a mail fetch and reload the UI.


License
-------

Copyright 2015 <NAME>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
{'fraction_non_alphanumeric': 0.07338333671194, 'fraction_numerical': 0.003243462396107845, 'mean_word_length': 3.919242273180459, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 10, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7330693', 'n_tokens_mistral': 1367, 'n_tokens_neox': 1287, 'n_words': 679}