OliverTED/imap-filter-go

imap-filter-go: Filter an IMAP Mailbox from cli/mutt/etc

'imap-filter-go' is a simple cli tool to log into an imap server and rule based filter the email messages (such as moving all messages from a certain sender to a specific folder)

Install

Install via golang's install directive:

go install github.com/OliverTED/imap-filter-go@latest

The executable will be in 'GOPATH/bin' (usually '~/go/bin').

Quickstart

To quickly apply a email filter:

imap-filter-go --verbose \
    --host imap.myserver.com --ssl --port 993 \
    --user testuser@myserver.com \
    --password-eval 'echo mypassword' \
    dry-run \
    --rule 'from:*@dailycodingproblem.com:INBOX/learn-coding'
    --rule 'from:*@indiehackers.com:INBOX/indiehackers'

This will show you all emails that match '@dailycodingproblem.com' would be moved to 'INBOX/learn-coding' and anything matching '@indiehackers.com' to 'INBOX/indiehackers'. Changing 'dry-run' to 'execute' would not only print, but actually move the messages.

All those parameters can be stored inside the configuration '~/.config/imap_filter_go.toml':

[account.default]
host = 'imap.myserver.com
inbox = 'INBOX'
password_eval = 'echo mypassword'
ssl = true
user = 'testuser@myserver.com'
port = 993
rules = [
  'from:*@dailycodingproblem.com:INBOX/learn-coding',
  'from:*@indiehackers.com:INBOX/indiehackers',
]

Mutt

Put these lines into your 'muttrc' to have 'Mod+f' start the imap-filter and 'Mod-Shift-f' add a new rule:

macro index \ef "<shell-escape>term -e bash -c \"imap_filter_go execute; read\" &<enter>"
macro index \eF "<shell-escape>term -e bash -c \"imap_filter_go add-rule --interactive\" &<enter>"

Development

Sources can be downloaded from github. Then go install ... installs the current sources onto your system. Push requests are welcome.