Connect to an IMAP server and run a command when new email arrives

Go to file

Florian Stecker 2a4e9ae4bc improve handling of some rare errors		2023-07-13 22:04:27 +02:00
src	improve handling of some rare errors	2023-07-13 22:04:27 +02:00
.gitignore	add README.md	2023-01-01 23:27:40 +01:00
Cargo.lock	better error handling, intervals	2022-12-03 17:24:05 -05:00
Cargo.toml	better error handling, intervals	2022-12-03 17:24:05 -05:00
README.md	clarify readme	2023-02-20 18:59:01 -05:00

README.md

imapidle - run command on new email

This is a very simple program which connects to an IMAP server and waits for email to arrive, using the IDLE command. Every time a new email arrives it runs a command. This can be useful to trigger a refresh in email clients that don't support IDLE themselves.

Although this is quite minimal and only implements a tiny subset of the IMAP protocol, it is supposed to be robust with respect to connection errors. The idea is that this gets started once at system startup and then survives bad wifi, suspending the machine, etc.

Installation

Get Rust and run

cargo build --release

which creates the binary at the path target/release/imapidle.

Usage

The output of imapidle --help does a good job at explaining how to use it:

$ imapidle --help
Uses IMAP IDLE to run a command whenever a new email arrives

Usage: imapidle [OPTIONS] --server <SERVER> --username <USERNAME> --password <PASSWORD> --command <COMMAND>

Options:
  -s, --server <SERVER>      IMAP server domain
  --port <PORT>              IMAP server port [default: 993]
  -u, --username <USERNAME>  IMAP user name
  -p, --password <PASSWORD>  IMAP password
  -i, --interval <INTERVAL>  interval (in seconds) at which to run even if no email arrives
  -c, --command <COMMAND>    command to run when new mail arrives
  -v, --verbose...           show all server responses
  -h, --help                 Print help information

Note that it only supports TLS encrypted IMAP and plain password authentication. Also, it currently reads the password from the command line, which isn't a great thing to do. I might change that eventually.

Goals

I made this for the following reasons:

I wanted my emails to arrive faster and without having to manually hit the refresh button.
I wanted to find out how IMAP works and why it's often so slow (I'm still not really sure).
I wanted to try using Rust for something practical and see how well it works. It worked pretty well.

In terms of actual usability, this works fine for me, but I'm sure there are better alternatives out there.