postal-list(1)

πŸ’– postal-list(1) β€” the Postal era πŸ’–

okay bestie, welcome to postal-list, a lil program from the Postal fam (manual section 1, she's a user command, main character energy fr fr) ✨


✨ NAME ✨

postal-list β€” a program that shows you exactly how postal expands user names 🫢


πŸŽ€ SYNOPSIS πŸŽ€

postal-list user-list-filename conversion-filename

like. two filenames. that's it. she's low maintenance πŸ’…


🌸 DESCRIPTION 🌸

So basically this program shows you the expansion that the postal program does to email addresses. Why do you care?? Two reasons, bestie:

  • it lets you make sure your configuration files do what you expect them to do β€” vibe check your config before it betrays you 😭
  • it can produce a list of user-names for an account creation script, in case you wanna create a million test accounts in a convenient fashion πŸ”₯ (yes, a million. we love a productive queen πŸ‘‘)

user-list-filename is the name of a file containing a list of users' email addresses. And it's flexible bestie β€” these can be just user-names, or fully qualified email addresses. Either one, we don't judge πŸ’–

conversion-filename is the name of a file containing the conversions to apply to email addresses. Every line in that file is either:

  • a comment (a line starting with "#"), or
  • a line with two parameters ✌️

Let's break the two parameters down:

  1. The first parameter is the regular expression. For each email that's to be sent, a randomly selected user-name gets checked against all the regular expressions, and the first match determines which translation gets applied. First come first served, periodt πŸŽ€
  2. The second parameter on the line is the translation. It'll contain a number of "." characters specifying characters in the name that are not to be translated. To specify the translations, you can specify a range of characters inside square brackets πŸ¦‹

For example β€” and this is the example, not me making stuff up β€” to have every address starting with "a" have a character from "01234567890abc" as its second character, and a character from "xyz" as its third character, you'd have the following:

^a .[0-9abc][xyz]

look at her go 😌✨


⭐ RETURN CODES ⭐

  • 0 β€” No Error πŸ₯³ slay, it worked
  • 1 β€” Bad Parameters πŸ’€ something you passed in was not it

πŸ’œ AUTHOR πŸ’œ

This program, its manual page, and the Debian package were written by Russell Coker <russell@coker.com.au> 🫢 iconic behavior, thank you for your service


🌈 AVAILABILITY 🌈

The source is available from http://doc.coker.com.au/projects/postal/ .

See http://etbe.coker.com.au/category/benchmark for further information πŸ‘€


πŸ¦‹ SEE ALSO πŸ¦‹

postal(8), rabid(8), regex(7)

go read those too, they're the friend group πŸ’…βœ¨


okay that's the whole page bestie!! this one's from russell@coker.com.au, version 0.70, and yeah β€” she's postal-list(1) through and through πŸŽ€πŸ’– stay hydrated, check your regexes, and remember: first match wins, no cap ✨🫢