Skip to content

Commit

Permalink
Merge branch 'pr/7'
Browse files Browse the repository at this point in the history
  • Loading branch information
dhellmann committed Nov 12, 2017
2 parents 825b525 + 6577676 commit 7b0a29e
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions doc/source/configuring.rst
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,20 @@ trash mailbox. There is no default value.
trash-mailbox: INBOX.Trash
Mailboxes
=========

The mailboxes that imapautofiler should process are listed under ``mailboxes``.
Each mailbox has a name and a list of rules.

.. code-block:: yaml
mailboxes:
- name: INBOX
rules: ...
- name: Sent
rules: ...
Rules
=====

Expand Down Expand Up @@ -338,3 +352,35 @@ regular expression ``notify-.*@disqus.net``.
regex: "notify-.*@disqus.net"
action:
name: delete
Complete example configuration file
===================================

Here's an example of a configuration file with all the possible parts.

.. code-block:: yaml
server:
hostname: imap.gmail.com
username: user@example.com
password: xxxxxxxxxxxxxx
trash-mailbox: "[Gmail]/Trash"
mailboxes:
- name: INBOX
rules:
- headers:
- name: "from"
substring: user1@example.com
action:
name: "move"
dest-mailbox: "User1 correspondence"
- headers:
- name: recipient
substring: dev-team
- name: subject
substring: "[Django] ERROR"
action:
name: "move"
dest-mailbox: "Django Errors"

0 comments on commit 7b0a29e

Please sign in to comment.