postfixadmin-cli(1)

πŸ“¦
version 4.0.5 Β· 3 versions
, in ubuntu stonking

πŸ’– postfixadmin-cli β€” the manual page, but make it make sense πŸ’–

okay bestie, so this is the postfixadmin-cli(1) page, and honestly? it's giving "I run your whole mail server from a terminal and I'm not even stressed about it." Let's get into it. 🫢


πŸŽ€ Name πŸŽ€

postfixadmin-cli β€” a CLI tool to manage postfixadmin. that's it, that's the whole name section, we ate. πŸ’…


✨ SYNOPSIS ✨

postfixadmin-cli <module> <task> [options]

postfixadmin-cli <module> help

postfixadmin-cli <module> <task> help

three whole ways to call it, and each one is a vibe. ✨


🌸 DESCRIPTION 🌸

postfixadmin-cli is a CLI tool that lets you use postfixadmin the same way you'd use the WebUI, except you're in a terminal and you feel like a hacker. πŸ‘‘ It's a shell script wrapped around /usr/share/postfixadmin/scripts/postfixadmin-cli.php.

lowkey iconic. highkey useful. no cap. πŸ”₯


πŸ¦‹ MODULES πŸ¦‹

here are the modules, bestie, all six of them, alphabetically slaying:

  • admin
  • domain
  • mailbox
  • alias
  • aliasdomain
  • fetchmail

🌈 TASKS 🌈

most modules support these tasks (the word "most" is doing a lot of work here, please note it πŸ™ˆ):

  • view β€” View an item.
  • add β€” Add an item.
  • update β€” Update an item.
  • delete β€” Delete an item.
  • scheme β€” Print database scheme (useful for developers only).
  • help β€” Print help output.
⭐ friendly reminder that it says most modules. if one of these tasks isn't there for your module combo, that's just how it is, don't come for me, I'm just the messenger. πŸ’€

πŸ’œ OPTIONS πŸ’œ

okay so here's the thing fr fr: different combinations of MODULES and TASKS have different sets of available options to use. it's not one universal list, it's a choose-your-own-adventure situation. 🧚

so please, bestie, look at the help messages and check the examples right below this. πŸ™


πŸ“ EXAMPLES πŸ“

adding a mailbox, but make it interactive πŸŽ€

postfixadmin-cli mailbox add

you run it, it asks you stuff, you answer, boom. conversational. πŸ’¬

adding a mailbox non-interactively, with the new mailbox being inactive πŸ’€

postfixadmin-cli mailbox add nobody@example.com --password deadbeef12
--password2 deadbeef12 --name "Nobody Nogroup" --welcome-mail --active 0
--email-other backup@example.com

no prompts, no small talk, just flags. main character energy. ✨ (and yes, the new mailbox is inactive here, that's the --active 0 doing its thing, we see it, we respect it.)

viewing the info of a domain πŸ‘€

postfixadmin-cli domain view example.com

stalking your own domains is self care, actually. πŸ’…


😭 REPORTING BUGS 😭

found something broken? please report bug(s) to the Debian BTS, i.e. using reportbug(1). πŸ› the maintainers want to know, and honestly it's the polite thing to do.


πŸ‘‘ SEE ALSO πŸ‘‘

go read these too, they're the extended universe:

postfix(1), postconf(1), postmap(1), mariadb(1), psql(1), php(1)


🫢 AUTHOR 🫢

Copyright 2024 Luke Yasuda <jing@jing.rocks>.

This manpage was written by Luke Yasuda, licensed under the terms of GNU General Pulic License version 2, or at your option any later version. There is absolutely no warranty; see /usr/share/common-licenses/GPL-2 for the terms of the license.

⚠️ bestie, real talk: absolutely no warranty. zero. none. it literally says so, and the license text says so too. check /usr/share/common-licenses/GPL-2 if you want the receipts. ⚠️

and that's the whole page, babes. πŸ’– this one's from the PostfixAdmin era, dated 2025-11-07. go forth and postfixadmin-cli responsibly. slay. πŸŒŸπŸŽ€βœ¨

πŸ“¦ where this page comes from