summaryrefslogtreecommitdiffstats
path: root/src/plugins/abrt-action-mailx.txt
blob: a12c2bf128b8b6e905ed3378d32aec02feacaccd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
abrt-action-mailx(1)
====================

NAME
----
abrt-action-mailx - Sends contents of a dump directory via email.

SYNOPSIS
--------
'abrt-action-mailx' [-v] -d DIR [-c CONFFILE]

DESCRIPTION
-----------
The tool reads a problem dump directory, composes an email message
from the directory contents, and uses mailx to send the message to
specified recipient.

Properties of email messages can be specified in a configuration file,
and via environment variables.

Configuration file
~~~~~~~~~~~~~~~~~~
Configuration file contains entries in a format "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 dump
       directory to the email. This can cause the emails to be very
       large.

Integration with ABRT events
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
'abrt-action-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/abrt/events.d/mailx_events.conf:

------------
EVENT=report_Mailx      abrt-action-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       abrt-action-mailx
------------

OPTIONS
-------
-d DIR::
   Path to dump directory.

-c CONFFILE::
   Path to configration file. When used in ABRT event system, the file
   contains site-wide configuration. Users can change the values via
   environment variables.

ENVIRONMENT VARIABLES
---------------------
Environment variables take precedence over values provided in
the configuration file.

'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 dump
       directory to the email.

AUTHORS
-------
* ABRT team