REPORTER-MAILX(1)

💌 REPORTER-MAILX(1) 💌

okay so welcome to the LIBREPORT MANUAL page for reporter-mailx, bestie. this one is a little email-sending icon: it grabs a problem directory, builds an email from what’s inside, and hands it to mailx so it can go to the recipient you picked. ✨

you can set email message properties in a config file, and through environment variables too. and there’s a whole formatting-file situation for making the email look how you want. 🎀

🌸 NAME 🌸

reporter-mailx — sends the contents of a problem directory via email. 💌

🦋 SYNOPSIS 🦋

reporter-mailx [-v] -d DIR [-c CONFFILE] [-F FMTFILE]

✨ DESCRIPTION ✨

here’s the vibe: the tool reads a problem directory, puts together an email message from the directory contents, and uses mailx to send that message to specified recipient. 📬

you can specify the email message’s properties in a configuration file, and via environment variables. 💅

🎀 Configuration file 🎀

the configuration file is full of entries shaped like Option = Value.

the options are:

• Subject — the subject of the email message. ✉️
• EmailFrom — the sender of the email message. 🫶
• EmailTo — the recipient of the email message. 📮
• SendBinaryData — use yes/true/on/1 to attach all binary files from the problem directory to the email. heads up: this can cause the emails to be very large. 😭

🧚 Formatting configuration files 🧚

lines starting with # are ignored.

lines can be continued on the next line using trailing backslash.

format:

%summary:: subject format
section:: element1[,element2]...

there’s also the literal text line to be added to email. it can be empty. (empty lines are NOT ignored! 💀)

subject format is a line of text, where %element% is replaced by text element’s content, and [[...%element%...]] block is used only if %element% exists. [[...]] blocks can nest.

sections can be:

• %summary: email subject format string.
• %attach: a list of elements to attach.
• text, double colon (::) and the list of comma-separated elements.

elements can be:

• problem directory element names, which get formatted as:

<element_name>: <contents>

or:

<element_name>:
:<contents>
:<contents>
:<contents>

• problem directory element names prefixed by %bare_, which is formatted as-is, without <element_name>: and colons.
• %oneline, %multiline, %text wildcards, which select all corresponding elements for output or attachment.
• %binary wildcard, valid only for %attach section, instructs to attach binary elements.
• problem directory element names prefixed by -, which excludes given element from all wildcards.

nonexistent elements are silently ignored. if none of elements exists, the section will not be created. no drama, it just doesn’t show up. 💅

🌈 Integration with ABRT events 🌈

reporter-mailx can be used as a reporter, to allow users report problems via email when they decide to do it. this usage is pre-configured in /etc/libreport/events.d/mailx_event.conf:

EVENT=report_Mailx      reporter-mailx

it can also be used to notify administrator automatically when a problem happens. when this is desired, modify the event configuration file to run the tool on the post-create event:

EVENT=post-create       reporter-mailx

👑 OPTIONS 👑

• -d DIR — path to problem directory. 📁
• -c CONFFILE — path to configuration file. when used in ABRT event system, the file contains site-wide configuration. users can change the values via environment variables. 🔧
• -F CONF_FORMAT_FILE — formatting file for an email. 🎨

💜 ENVIRONMENT VARIABLES 💜

environment variables take precedence over values provided in the configuration file. main character energy, honestly. 👑

• Mailx_Subject — subject of the email message. ✉️
• Mailx_EmailFrom — sender of the email message. 🫶
• Mailx_EmailTo — recipient of the email message. if nor the environment variable nor the corresponding option is defined, the message is send to "root@localhost". 📬
• Mailx_SendBinaryData — use yes/true/on/1 to attach all binary files from the problem directory to the email. 📎

🍓 FILES 🍓

• /usr/share/libreport/conf.d/plugins/mailx.conf — readonly default configuration files. 🔒
• /etc/libreport/plugins/mailx.conf — configuration files. 📝

🔥 SEE ALSO 🔥

mailx_event.conf(5), mailx.conf(5), report_mailx.conf(5)

🌟 AUTHORS 🌟

• ABRT team 👑

mwah 💋 — this iconic little page is from LIBREPORT 2.17.15, dated 07/15/2024. stay legendary, bestie. 🫶