﻿<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet href="scheduler.xsl" type="text/xsl"?>

<!--$Id: email.xml 3623 2005-04-20 06:53:16Z jz $-->

<description 
    title               = "Sending E-mails" 
    base_dir            = ""
    author              = "$Author: jz $"
    date                = "$Date: 2005-12-07 11:41:44 +0100 (Mi, 07 Dez 2005) $"
>

    <h2>E-mail Settings</h2>
<!--<h2>Einstellungen zur E-mail</h2>-->

        <p>
            General E-mail settings are made as follows:
        <!--Die Einstellungen für eine eMail können Sie hier vornehmen:-->
            <div class="indent">
                <scheduler_ini_entry file="factory.ini" section="spooler" entry="smtp"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="spooler" entry="log_mail_subject"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="spooler" entry="log_mail_from"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="spooler" entry="log_mail_to"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="spooler" entry="log_mail_cc"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="spooler" entry="log_mail_bcc"/>
            </div>
        </p>
        <p>
            and settings for particular jobs are made thus:
        <!--Oder wenn Sie besondere Einstellungen für einen bestimmten Job vornehmen wollen:-->
            <div class="indent">
                <scheduler_ini_entry file="factory.ini" section="job" entry="log_mail_subject"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="job" entry="log_mail_from"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="job" entry="log_mail_to"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="job" entry="log_mail_cc"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="job" entry="log_mail_bcc"/>
            </div>
        </p>
        <p>
            Or in the application programming interface:
        <!--Oder an der Programmschnittstelle:-->
        </p>
        <div class="indent">
            The 
            <scheduler_method class="Job_impl" property="spooler_log"/>
            class provides the 
            <scheduler_method class="Log" property="mail"/>
            object, which in turn makes the 
            <scheduler_method class="Mail"/>
            object available.
            This allows sender, recipient, re., etc. to be set using the methods of the 
            <scheduler_method class="Mail"/>
            object.
        <!--<scheduler_method class="Job_impl" property="spooler_log"/>
            stellt mit 
            <scheduler_method class="Log" property="mail"/>
            das Objekt 
            <scheduler_method class="Mail"/>
            bereit,
            über dessen Methoden Sie Absender, Empfänger, Betreff usw. einstellen können.-->
            
            <p class="example">Example (in Java)</p>
        <!--<p class="example">Beispiel (in Java)</p>-->
            <pre>
spooler_log.mail().set_to( "admin@xxx.com" );
            </pre>
        </div>

    
    <h2>E-mails Sent after Task Completion</h2>
<!--<h2>eMails nach dem Ende einer Task</h2>-->

        <p>
            On completion of a task, the Job Scheduler can send an E-mail containing the task protocol.
        <!--Wenn eine Task endet, kann der Scheduler eine eMail mit dem Task-Protokoll verschicken.-->
        </p>
        <p>
            The following settings are used to determine the general conditions under which a protocol should be sent 
            on completion of a task:
        <!--Ob nach Ende einer Task das Protokoll verschickt werden soll, bestimmen Sie mit diesen Einstellungen:-->
            <div class="indent">
                <scheduler_ini_entry file="factory.ini" section="spooler" entry="mail_on_success"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="spooler" entry="mail_on_process"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="spooler" entry="mail_on_error"/>
            </div>
        </p>
        <p>
            The following settings are used to determine the conditions for a particular job:
        <!--Und speziell für einen Job:-->
            <div class="indent">
                <scheduler_ini_entry file="factory.ini" section="job" entry="mail_on_success"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="job" entry="mail_on_process"/>
                <br/>
                <scheduler_ini_entry file="factory.ini" section="job" entry="mail_on_error"/>
                <br/>
            </div>
        </p>
        <p>
            and in the application programming interface:
        <!--Oder an der Programmschnittstelle:-->
        </p>
        <div class="indent">
            The 
            <scheduler_method class="Log" property="mail_it"/>
            request is used to determine whether the Job Scheduler sends a protocol on completion of a task.
        <!--Mit dem Aufruf 
            <scheduler_method class="Log" property="mail_it"/>
            können Sie einstellen, ob der Scheduler beim Ende der Task das Protokoll sendet.-->
        </div>
        
        
    <h2>Settings Priorities</h2>
<!--<h2>Rangfolge der Einstellungen</h2>-->
        
        <ol>
            <li>
                The job script uses the <scheduler_method class="Mail"/> class to make settings.
            <!--Das Job-Skript kann Einstellungen mit der Klasse <scheduler_method class="Mail"/> vornehmen.-->
            </li>
            <li>
                Should an error occur, the Job Scheduler overwrites the mail subject 
                - i.e. the job
                <scheduler_method class="Mail" property="log_mail_subject"/> 
                setting.
            <!--Im Fehlerfall setzt der Scheduler den Betreff, 
                überschreibt also die Einstellung
                <scheduler_method class="Mail" property="log_mail_subject"/> 
                des Jobs.-->
            </li>
            <li>
                The e-mail XSLT stylesheet 
                (<scheduler_element name="config" attribute="mail_xslt_stylesheet"/>),
                can make used to make the settings.
            <!--Das eMail-XSLT-Stylesheet 
                (<scheduler_element name="config" attribute="mail_xslt_stylesheet"/>),
                kann die Einstellungen ändern.-->
            </li>
            <li>
                Empty settings are filled with values from
                <br/>
                <scheduler_ini_entry file="factory.ini" section="job"/>
                and
                <br/>
                <scheduler_ini_entry file="factory.ini" section="spooler"/>
                . 
            <!--Leere Einstellungen werden mit den Angaben aus
                <br/>
                <scheduler_ini_entry file="factory.ini" section="job"/>
                und
                <br/>
                <scheduler_ini_entry file="factory.ini" section="spooler"/>
                gefüllt. -->
            </li>
        </ol>
            
    
    
    <h2>E-mails Sent when the Job Scheduler Terminates because of an Error</h2>
<!--<h2>eMails, wenn der Scheduler wegen eines Fehlers sich beendet</h2>-->

        <p>
            The settings for e-mails sent when the Scheduler terminates because of an error 
            are to be found in section <code>[spooler]</code> of the <code>factory.ini</code> file.
        <!--Für diese eMails werden die Einstellungen im Abschnit <code>[spooler]</code> 
            der Datei <code>factory.ini</code> verwendet.-->
        </p>
        <p>
            Should a error occur before the <scheduler_option name="ini"/> option can be carried out,
            the Job Scheduler uses the (default) settings from the <code>factory.ini</code> file under its original name.
        <!--Wenn ein Fehler auftritt, 
            bevor die Option <scheduler_option name="ini"/> berücksichtigt werden konnte,
            verwendet der Scheduler die Einstellungen aus der Datei <code>factory.ini</code> mit unverändertem Namen.-->
        </p>
        <p>
            When running as a service or daemon the Job Scheduler will send an e-mail containing the relevant error message,
            should an error occur which is so serious that the Job Scheduler must abort.
        <!--Wenn der Scheduler als Dienst oder Daemon läuft und 
            ein Fehler auftritt, der so ernst ist, dass der Scheduler abbrechen muss,
            verschickt er eine eMail mit der Fehlermeldung.-->
        </p>    
        <p>
            The Job Scheduler sends an e-mail should a database error occur.
            Further e-mails about errors caused by subsequent attempts to reopen the database are not sent.
        <!--Wenn ein Datenbankfehler auftritt, verschickt der Scheduler eine eMail.
            Fehler, die bei den Versuchen auftreten, die Datenbank erneut zu öffnen, führen nicht zu einer eMail.-->
        </p>
        <p>
            An e-mail is also sent should the Job Scheduler have to stop using a database after an error.
        <!--Wenn der Scheduler nach einem Fehler den Datenbankbetrieb aufgibt, schickt er eine eMail.-->
        </p>

    
    <h2>
        Installation with JavaMail
    <!--Installation mit JavaMail-->
    </h2>
    
        <p>
            The following files must be added to the <code>class_path</code> directory 
            when an e-mail is to be sent using JavaMail.
        <!--Für den eMail-Versand mit JavaMail werden folgende Dateien im <code>class_path</code> benötigt.-->
        </p>

        <p>
            <table cellspacing="0" cellpadding="0">
                <col valign="baseline" class="code"/>
                <col valign="baseline"/>
                <tr>
                    <td>
                        sos.mail.jar
                    </td>
                    <td class="small" style="padding-left: 2ex">
                        (is delivered with the Job Scheduler)
                    <!--(wird mit dem Scheduler geliefert)-->
                    </td>
                </tr>
                <tr>
                    <td>
                        mail.jar
                    </td>
                    <td class="small" style="padding-left: 2ex">
                        (Sun Microsystems, Inc.)
                    </td>
                </tr>
                <tr>
                    <td>
                        smtp.jar
                    </td>
                    <td class="small" style="padding-left: 2ex">
                        (Sun Microsystems, Inc.)
                    </td>
                </tr>
                <tr>
                    <td>
                        activation.jar
                    </td>
                    <td class="small" style="padding-left: 2ex">
                        (Sun Microsystems, Inc.)
                    </td>
                </tr>
            </table>

            <br/>            
            See <scheduler_ini_entry file="sos.ini" section="java" entry="class_path"/>.
        <!--Siehe <scheduler_ini_entry file="sos.ini" section="java" entry="class_path"/>.-->
        </p>
            
    

</description>
