FDM(1)

πŸ’Œ FDM(1) β€” fetch and deliver mail πŸ’Œ

okay bestie, sit down, hydrate, because this one is a whole system. We're in the General Commands Manual section, and this is fdm β€” the fetch-and-deliver-mail icon. ✨


🌸 NAME 🌸

fdm β€” fetch and deliver mail 🫢


✨ SYNOPSIS ✨

fdm [-hklmnqv] [-a account] [-D name=value] [-f conffile] [-u user]
    [-x account] [fetch | poll | cache]

πŸ’– DESCRIPTION πŸ’–

Okay so the whole vibe of fdm is this: it fetches mail from a POP3 or IMAP server, or straight from stdin, and then delivers it based on a ruleset living in the configuration file. That's it. That's the girl. πŸ‘‘

Here are the options, no skips, no skimming, we're doing all of them: πŸ’…


πŸŽ€ OPTIONS πŸŽ€

  • -a name β€” Process only the specified account. You can drop this option multiple times, no cap. And the account name can include shell glob characters so you can match a bunch of accounts in one go. 🌈
  • -D name=value β€” Defines a macro for use when parsing the configuration file. Heads up bestie: the macro name must be prefixed with $ or % β€” $ means a string macro, % means a numeric one. This option may appear multiple times too. ✨
  • -f conffile β€” Specify where the configuration file lives. Default is ~/.fdm.conf, or /etc/fdm.conf if that first one doesn't exist. πŸ—‚οΈ
  • -h β€” Look at the HOME environment variable to figure out the user's home directory. 🏠
  • -k β€” Keep all mail after delivery, regardless of whether it matches a drop action.
⚠️ Careful though: mails kept this way will be refetched by fdm if you run it again on the same account. Not a vibe, just a fact. πŸ’€
  • -l β€” Log using syslog(3) instead of to stderr. πŸ“
  • -m β€” Ignore the lock file and run anyway, regardless of other instances of fdm running. Chaotic behavior, but okay! πŸ™ˆ
  • -n β€” Don't process any accounts at all β€” just verify the configuration file syntax and exit. A lil dry run for the grammar girlies. βœ…
  • -q β€” Quiet mode. Only errors get printed. 🀫
  • -u user β€” Specify the default user for delivery. This overrides the default-user option in the configuration file. πŸ‘‘
  • -v β€” Request verbose logging. May be specified multiple times, and each level gives you more tea:
    • -vv prints information on configuration (super useful with -n) πŸ”
    • -vvvv duplicates all traffic to and from remote servers to stdout πŸ‘€
    • This feature is disabled when using the -l flag.
  • -x name β€” Exclude the named account. Multiple -x options may be specified, and just like with -a, shell glob characters may be used. 🚫
  • fetch | poll | cache β€” The command, and here's the rundown:
    • fetch tells fdm to fetch and deliver messages. πŸ“¬
    • poll polls the accounts in the configuration file and reports a message count for each. πŸ“Š
    • cache lets you manipulate fdm cache files β€” see the next section, bestie. πŸ‘‡

πŸ¦‹ CACHE COMMANDS πŸ¦‹

The following cache manipulation commands are supported, and yes we're listing every single one: 🫢

  • cache add path string
  • cache remove path string

Add or remove string as a key in the cache at path. πŸ—οΈ

  • cache list [path] β€” List the number of keys in the specified cache. If path is omitted, it lists them in all caches declared in the configuration file. πŸ”’
  • cache dump path β€” Dump the contents of the cache path to stdout. Each key is printed followed by a space and the timestamp as Unix time. πŸ•°οΈ
  • cache clear path β€” Delete all keys from the cache at path. Poof. Gone. πŸ’¨

🧚 FILES 🧚

  • ~/.fdm.conf β€” default fdm configuration file πŸ“„
  • /etc/fdm.conf β€” default system-wide configuration file πŸ›οΈ
  • ~/.fdm.lock β€” default lock file πŸ”’
  • /var/db/fdm.lock β€” lock file for the root user πŸ‘‘

⭐ SEE ALSO ⭐

mail(1), fdm.conf(5), sendmail(8) β€” go read your sisters, they ate. πŸ’…


πŸ’œ AUTHORS πŸ’œ

Nicholas Marriott <nicholas.marriott@gmail.com> β€” the icon, the legend, the moment. πŸ‘‘


and that's the whole page bestie, every flag, every file, every cache command, nothing skipped, we ate and left no crumbs. πŸ“

This cutie was brought to you by Debian, dated December 22, 2008, and filed under FDM(1) β€” periodt. πŸ’–βœ¨

πŸ“¦ where this page comes from