1Smokeping_probes_SendEmail(3)      SmokePing     Smokeping_probes_SendEmail(3)
2
3
4

NAME

6       Smokeping::probes::SendEmail - a Smokeping probe that measure time
7       neeed to send an mail
8

SYNOPSIS

10        *** Probes ***
11
12        +SendEmail
13
14        bodysize = 0
15        forks = 5
16        from = test@test.com # mandatory
17        offset = 50%
18        step = 300
19        subject = Test
20        timeout = 15
21        to =  # mandatory
22
23        # The following variables can be overridden in each target section
24        pings = 5
25        port = 25
26
27        # [...]
28
29        *** Targets ***
30
31        probe = SendEmail # if this should be the default probe
32
33        # [...]
34
35        + mytarget
36        # probe = SendEmail # if the default probe is something else
37        host = my.host
38        pings = 5
39        port = 25
40

DESCRIPTION

42       This probe actually send a mail to a MX server and measure time it
43       took. You can choose the sender and recipient adress as well as the
44       size of the mail.
45

VARIABLES

47       Supported probe-specific variables:
48
49       bodysize
50           Size of the mail to send in bytes. If set to 0, a default mail
51           content will be set. Note that mail always contain From, To and
52           Subject headers.
53
54           Default value: 0
55
56       forks
57           Run this many concurrent processes at maximum
58
59           Example value: 5
60
61           Default value: 5
62
63       from
64           Mail from address
65
66           Example value: test@test.com
67
68           This setting is mandatory.
69
70       offset
71           If you run many probes concurrently you may want to prevent them
72           from hitting your network all at the same time. Using the probe-
73           specific offset parameter you can change the point in time when
74           each probe will be run. Offset is specified in % of total interval,
75           or alternatively as 'random', and the offset from the 'General'
76           section is used if nothing is specified here. Note that this does
77           NOT influence the rrds itself, it is just a matter of when data
78           acqusition is initiated.  (This variable is only applicable if the
79           variable 'concurrentprobes' is set in the 'General' section.)
80
81           Example value: 50%
82
83       step
84           Duration of the base interval that this probe should use, if
85           different from the one specified in the 'Database' section. Note
86           that the step in the RRD files is fixed when they are originally
87           generated, and if you change the step parameter afterwards, you'll
88           have to delete the old RRD files or somehow convert them. (This
89           variable is only applicable if the variable 'concurrentprobes' is
90           set in the 'General' section.)
91
92           Example value: 300
93
94       subject
95           Subject of the mail
96
97           Default value: Test
98
99       timeout
100           How long a single 'ping' takes at maximum
101
102           Example value: 15
103
104           Default value: 5
105
106       to  Rcpt to address
107
108           This setting is mandatory.
109
110       Supported target-specific variables:
111
112       pings
113           How many pings should be sent to each target, if different from the
114           global value specified in the Database section. Note that the
115           number of pings in the RRD files is fixed when they are originally
116           generated, and if you change this parameter afterwards, you'll have
117           to delete the old RRD files or somehow convert them.
118
119           Example value: 5
120
121       port
122           Port of the SMTP server to reach
123
124           Default value: 25
125

AUTHORS

127        Florian Coulmier <florian@coulmier.fr>,
128

SEE ALSO

130       smokeping_extend
131
132
133
1342.7.3                             2021-07-23     Smokeping_probes_SendEmail(3)