1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM 'global.entities'>
10 <refentry id='script-email.8'>
13 <refentrytitle>script-email</refentrytitle>
14 <manvolnum>8</manvolnum>
20 <refname>script-email</refname>
21 <refpurpose>Amanda script to send email notifications</refpurpose>
27 <!-- body begins here -->
29 <refsect1><title>DESCRIPTION</title>
31 <para>script-email is an Amanda script implementing the Script API. It should not
32 be run by users directly. It sends a notification email to the addresses
33 specified in the MAILTO property.</para>
37 <refsect1><title>PROPERTIES</title>
39 <para>This section lists the properties that control script-email's functionality.
40 See <manref name="amanda-scripts" vol="7"/>
41 for information on the Script API, script configuration.</para>
43 <!-- PLEASE KEEP THIS LIST IN ALPHABETICAL ORDER -->
46 <varlistentry><term>MAILTO</term><listitem>
47 List of email addresses that will receive an email on command execution. It is a multi-valued property:
49 property "MAILTO" "amanda@domain.com" "sysadmin@domain.com" "amandauser@domain.com"
51 </listitem></varlistentry>
57 <refsect1><title>EXAMPLE</title>
59 In this example, script-email is scheduled to be run before the DLE, on the
60 server. The unqualified email address <emphasis>amanda</emphasis> will be
61 passed to the email system unchanged. The script is then attached to a
62 dumptype, which can then be specified for any DLEs which require notification.
65 define script-tool pre-email {
66 comment "email me before this DLE is backed up"
68 execute-on pre-dle-backup
70 property "mailto" "amanda"
73 define dumptype user-tar-email {
81 <manref name="amanda.conf" vol="5"/>,
82 <manref name="amanda-client.conf" vol="5"/>,
83 <manref name="amanda-scripts" vol="7"/>