mmuxer 0.7.0

Manage mail from your server.

Mail Muxer

Are you tired of managing IMAP filters through cumbersome, slow and unintuive web interfaces ? Then Mail Muxer is here to save you from this pain !

Mail Muxer is a Python tool that will monitor your Inbox, and filter incomming emails according to the given configuration. It was designed to be intuitive and easy to use, by using compact configuration and sensible defaults: a rule can be as simple as

- condition:
    FROM: [e-mail]
  move_to: some/folder

Basic Usage

1. Install:

    pip install mmuxer
   

2. Create configuration file:

   rules:
     - move_to: receipts
       condition:
         ANY:
           - FROM: [e-mail]
           - FROM: [e-mail]
     - move_to: important
       condition:
         SUBJECT: important
     - condition:
         FROM: [e-mail]
       actions:
         - delete
   
   settings:
     server: imap.email.net
     username: [e-mail]
     password: secret
   

3. Check your configuration:

   mmuxer check --config-file config.yaml
   

4. Check your folders:

   mmuxer folder --config-file config.yaml compare-destinations
   

5. Monitor your inbox:

   mmuxer monitor --config-file config.yaml
   

6. Or apply on all messages of a given IMAP folder:

   mmuxer tidy --config-file config.yaml --folder FOLDER
   

7. Finally, to get help on a given command, add a --help to it, e.g.

   mmuxer monitor --help
   

Sieve interraction

MMuxer allows you to interract with sieves with the mmuxer sieve commands:

• list: List sieve scripts on the server.
• put: Upload a sieve script generated from rules to the server.
• export: Convert the rules of the give config file to sieve format.

Note that server support of managesieve commands is necessary for list and put commands to work.

Settings

Using env variables for settings

Settings values (username, password, etc.) can be configured by providing environment variables of the same name (case insensitive).

Exporting configuration to sieve format

mmuxer can also export the rules of a configuration file to the sieve format, so that the rules will be handled server side.

mmuxer sieve-export --config-file config.yaml --dest-file rules.sieve

Note on SSL

If you get SSL errors while connecting to your server, see the SSL Configuration section.

All available settings

server: str
username: str
password: str
ssl_ciphers: Optional[str] = None
imap_wait_timeout: int = 60

sieve:
  folder_prefix: str = ""  # folder prefix used when generating sieve rules
  folder_separator: str = "."  # folder separator used when generating sieve rules
  name: str | None = None  # name used when exporting with managesieve
  extensions: list[str] = ["fileinto"]

Going further on

• Advanced usage
• Use with docker/systemd: see doc

What's next

The current implementation is mostly feature complete for me, but here are some features that could be implemented:

• Improve tidy operation:
  • make tidy operation more performant by using IMAP search features
  • allow to run tidy on many / all folders
• Better conditions:
  • add a REGEX operator (although not compatible with IMAP search)
  • support more fields
• Add more actions:
  • tag emails
  • forward emails
  • move destination based on regex match group
  • automatic folder creation
  • anything else ?
• Hot-reload config file
• Re-configure (or execute actions) by sending emails
• Support OAuth / Gmail (I'm not sure how feasible that would be).

Don't hesitate to ask, or make a pull request !

Credit

This program relies on

• the imap-tools library for everything involving IMAP
• the mock IMAP server from aioimaplib for it's tests
• the ever excellent Typer and Pydantic libs

Many thanks to them !