IMAPFILTER(1)

💌 IMAPFILTER(1) — bestie edition ✨

okay so. imapfilter is a General Commands Manual situation, and it's literally the mail-filtering bestie you didn't know you needed. she's a whole main character and she's about to organize your entire inbox life. 🎀

---

🌸 NAME 🌸

imapfilter — mail filter 💅

---

✨ SYNOPSIS ✨

imapfilter [-inVv] [-c configfile] [-d debugfile] [-e 'command']
           [-l logfile] [-p pidfile] [-t truststore]

---

🦋 DESCRIPTION 🦋

okay so listen. imapfilter is a mail filtering utility, periodt. she connects to remote mail servers using the Internet Message Access Protocol (IMAP), sends searching queries over to the server, and then processes mailboxes based on whatever the results come back as. it's giving remote control for your mail, no cap. 💖

and the things she can do?? delete, copy, move, flag, etc. — all of it — on messages sitting in mailboxes on the same mail server or on different mail servers. iconic behavior honestly. and the 4rev1 and 4 versions of the IMAP protocol are supported. 🫶

the command line options of imapfilter(1) are as follows, bestie:

• -c configfile — the path to the configuration file to read. OR you can pass the '-' character to read the configuration straight from the standard input stream. the default is $HOME/.imapfilter/config.lua. 💜
• -d debugfile — the file that contains debugging information about the full communication with the server, along with other inner workings' details. she's telling you everything, fr fr. 🔍
• -e 'command' — may be used to enter "one line" of configuration, while it is also possible to pipe a full configuration as a string. ⚠️ when this option is used, a configuration file will not be loaded. heads up bestie.
• -i — enters interactive mode after executing the configuration file. she's staying to chat. 💬
• -l logfile — the file that contains logs of error messages produced. so when things go sideways you actually know why. 😭
• -n — this option enables the so called dry-run mode, and any actions that would result in changes to the server do not actually take place. so the requests that would modify any data are not sent to the server, even though informational messages about these actions are still printed. ✨

any other methods that only receive data from the server are performed as normal, such as for example the searching methods. 🧚

note that the number of messages an action is reported to be applied upon might differ between dry-run mode and the normal execution, and this is expected, because in the latter case the data on the server are continuously altered by subsequent actions. so don't come for her about the numbers, it's literally how it works. 💀

• -t truststore — the path to the system's SSL CA TrustStore directory or file. SSL connections will be validated using the CA certificates found in this directory or file, and when this is not possible, the local $HOME/.imapfilter/certificates file will be used. 🔐 the default CA directory is /etc/ssl/certs/, and the default CA file is /etc/ssl/cert.pem.
• -p pidfile — write the process ID (PID) to this file on startup, and delete it on exit. tidy queen. 👑
• -V — displays version and copyright information. slay. ⭐
• -v — enables printing of some brief details of the communication with the server. the ✨verbose✨ vibe check.

---

🌈 ENVIRONMENT 🌈

• HOME — user's home directory. 🏠
• IMAPFILTER_HOME — program's configuration directory, which overrides the default $HOME/.imapfilter/. 🗂️

---

🍓 FILES 🍓

• $HOME/.imapfilter/config.lua — default configuration file. because this file may contain sensitive data such as user passwords, the recommended permissions are read/write for the user, and not accessible by others. 🔒 protect her, bestie.
• $HOME/.imapfilter/certificates — file where the SSL certificates are stored. 📜

---

👀 SEE ALSO 👀

imapfilter_config(5)

---

🏆 CONFORMING TO 🏆

• IMAP4rev1: RFC 3501, RFC 3348, RFC 2683, RFC 2595, RFC 2342, RFC 2195, RFC 2177, RFC 5161, RFC 6855
• IMAP4: RFC 1730

---

and that's the whole page, babe. this one came out of the Debian fam, dated Dec 26, 2023 — shoutout to the Debian crew for keeping imapfilter(1) looking this good. 💖 mwah. go filter some mail. ✨