reporter-mailx(1)

1REPORTER-MAILX(1)              LIBREPORT MANUAL              REPORTER-MAILX(1)
2
3
4

NAME

6       reporter-mailx - Sends contents of a problem directory via email.
7

SYNOPSIS

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

DESCRIPTION

12       The tool reads a problem directory, composes an email message from the
13       directory contents, and uses mailx to send the message to specified
14       recipient.
15
16       Properties of email messages can be specified in a configuration file,
17       and via environment variables.
18
19   Configuration file
20       Configuration file contains entries in a format "Option = Value".
21
22       The options are:
23
24       Subject
25           The subject of the email message.
26
27       EmailFrom
28           The sender of the email message.
29
30       EmailTo
31           The recipient of the email message.
32
33       SendBinaryData
34           Use yes/true/on/1 to attach all binary files from the problem
35           directory to the email. This can cause the emails to be very large.
36
37   Formatting configuration files
38       Lines starting with # are ignored.
39
40       Lines can be continued on the next line using trailing backslash.
41
42       Format:
43
44           %summary:: subject format
45           section:: element1[,element2]...
46
47           The literal text line to be added to email. Can be empty.
48           (Empty lines are NOT ignored!)
49
50           Subject format is a line of text, where %element% is replaced by
51           text element's content, and [[...%element%...]] block is used only if
52           %element% exists. [[...]] blocks can nest.
53
54           Sections can be:
55           - %summary: email subject format string.
56           - %attach: a list of elements to attach.
57           - text, double colon (::) and the list of comma-separated elements.
58
59           Elements can be:
60           - problem directory element names, which get formatted as
61             <element_name>: <contents>
62             or
63             <element_name>:
64             :<contents>
65             :<contents>
66             :<contents>
67           - problem directory element names prefixed by "%bare_",
68             which is formatted as-is, without "<element_name>:" and colons
69           - %oneline, %multiline, %text wildcards, which select all corresponding
70             elements for output or attachment
71           - %binary wildcard, valid only for %attach section, instructs to attach
72             binary elements
73           - problem directory element names prefixed by "-",
74             which excludes given element from all wildcards
75
76           Nonexistent elements are silently ignored.
77           If none of elements exists, the section will not be created.
78
79   Integration with ABRT events
80       reporter-mailx can be used as a reporter, to allow users report
81       problems via email when they decide to do it. This usage is
82       pre-configured in /etc/libreport/events.d/mailx_event.conf:
83
84           EVENT=report_Mailx      reporter-mailx
85
86       It can also be used to notify administrator automatically when a
87       problem happens. When this is desired, modify the event configuration
88       file to run the tool on the post-create event:
89
90           EVENT=post-create       reporter-mailx
91

OPTIONS

93       -d DIR
94           Path to problem directory.
95
96       -c CONFFILE
97           Path to configuration file. When used in ABRT event system, the
98           file contains site-wide configuration. Users can change the values
99           via environment variables.
100
101       -F CONF_FORMAT_FILE Formatting file for an email.
102

ENVIRONMENT VARIABLES

104       Environment variables take precedence over values provided in the
105       configuration file.
106
107       Mailx_Subject
108           Subject of the email message.
109
110       Mailx_EmailFrom
111           Sender of the email message.
112
113       Mailx_EmailTo
114           Recipient of the email message. If nor the environment variable nor
115           the corresponding option is defined, the message is send to
116           "root@localhost".
117
118       Mailx_SendBinaryData
119           Use yes/true/on/1 to attach all binary files from the problem
120           directory to the email.
121

FILES

123       /usr/share/libreport/conf.d/plugins/mailx.conf
124           Readonly default configuration files.
125
126       /etc/libreport/plugins/mailx.conf
127           Configuration files.
128

AUTHORS

133       •   ABRT team
134
135
136
137LIBREPORT 2.17.11                 06/30/2023                 REPORTER-MAILX(1)