%
% mailquota.tex
% Last Update: $Id$
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%% Kapitel Mailquata %%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Achtung: Dateien muessen mit latin1-Encoding gespeichert werden!
% Attention: Files must be saved using latin1 encoding!
%

\chapter{Das Mailquota-Paket}

    Dieses Paket ist als Zusatzpaket zum Mail-Paket zu verstehen.
    Das Mail-Paket wird um eine Mail-Quota-Funktion erweitert, d.h.
    die definierten Werte schr"anken die Postfachgr"o"se f"ur alle oder
    einzelne Anwender ein.


\section{Die Einleitung}

    Das Mailquota-Paket greift auf die im Mail-Paket, "uber die Parameter
    MAIL\_USER\_... festgelegten Anwenderdaten zur"uck. Es k"onnen Standard-
    und individuelle Quota-Eintr"age definiert werden.


\section{Die Funktionen}

    Das Mailquota-Paket greift auf keine externen Programmpakete zur"uck.


\section{Die Voraussetzungen}

    Dieses Paket ben"otigt zur korrekten Funktion ein installierten Mail-Paket.


\section{Die Installation}

    Das Mailquota-Paket wird "uber das Setup-Men"u installiert. Wird eine
    "altere Paketversion vorgefunden, so wird diese deinstalliert bevor die
    neuen Programmdateien installiert werden. Nach dem Installieren der
    Programmdateien wird direkt der Konfigurations-Editor gestartet um die
    Konfiguration anzupassen. Nach Beendigung dieses Schrittes werden die
    Konfigurationsdateien generiert und alle ben"otigten Programme gestartet.


\section{Das Men"u im Setup-Programm}

    Das Men"u im Setup-Programm wird "uber 'Mail Services' -> 'Goto mail
    modules' angesprochen und ist wie folgt aufgebaut:

    \begin{itemize}
        \item Mailquota administration
        \begin{itemize}
            \item View documentation: Anzeigen der Dokumentation
            \item Edit configuration: Bearbeiten der Konfiguration
            \item Advanced configuration file handling: Konfigurationen verwalten
            \item View configuration log file: Die Konfigurations-Logmeldungen anzeigen
            \item Syncronize mail users: Mail-User aus dem Mail-Konfiguration "ubernehmen
            \item Return: Untermen"u verlassen
        \end{itemize}
        \item Return: Untermen"u verlassen
    \end{itemize}

    Die Men"upunkte d"urften selbsterkl"arend sein, da sie keinerlei weitere
    Eingaben erwarten. Aus diesem Grund wird auf deren Funktion nicht weiter
    eingegangen.


\section{Die "Anderung der Konfiguration}

    Die Konfiguration kann "uber den Men"upunkt 'Edit configuration' ge"andert
    werden.  Standardm"a"sig wird der Editor aufgerufen, der in der Environment-
    Konfiguration "uber die Variable 'EDITOR' festgelegt wurde. Nachdem der
    Editor beendet wurde wird abgefragt, ob die Konfiguration aktiviert werden
    soll. Wird dies best"atigt, werden "uber ein Skript die Anpassungen umgehend
    wirksam gemacht.


\section{Die Konfigurationsdatei}

    In der Konfigurationsdatei, die "uber das Men"u zug"anglich ist, sind folgende
    Parameter vorhanden; wer sie von Hand editieren will findet sie unter
    \texttt{/etc/config.d/mailquota}.

\section{Die Parameter}

\begin{description}
    \config{START\_MAILQUOTA}{START\_MAILQUOTA}{STARTMAILQUOTA}
        Wird dieser Parameter auf 'yes' gestellt, so wird das Mailquota-Paket
        aktiviert. Wird der Parameter auf 'no' gesetzt, so wird es deaktiviert.

        G"ultige Werte: yes, no

        Standardeinstellung: \texttt{START\_MAILQUOTA='no'}

   \config{MAILQUOTA\_DEFAULT\_QUOTA}{MAILQUOTA\_DEFAULT\_QUOTA}{MAILQUOTADEFAULTQUOTA}
        "Uber diesen Parameter wird der Standardwert f"ur die Mail-Quota konfiguriert.
        Der numerische Wert kann durch ein angeh"angtes 'K' f"ur Kilo- oder 'M' f"ur
        Megabyte erweitert werden. Wird dieser Parameter auf 0 gesetzt, so werden
        die Mail-Quota deaktiviert.

        G"ultige Werte: Speicherplatzangabe

        Standardeinstellung: \texttt{MAILQUOTA\_DEFAULT\_QUOTA='20M'}

    \config{MAILQUOTA\_DEFAULT\_QUOTA\_WARN\_THRESHOLD}{MAILQUOTA\_DEFAULT\_QUOTA\_WARN\_THRESHOLD}{MAILQUOTADEFAULTQUOTAWARNTHRESHOLD}
        "Uber diesen Parameter wird der Standardwert f"ur die Mail-Quota-
        Warnschwelle definiert. Zul"assig sind Werte zwischen 0 und 99,
        wobei 0 die Warnmeldungen deaktiviert.

        G"ultige Werte: Zahlenwert

        Standardeinstellung: \texttt{MAILQUOTA\_DEFAULT\_QUOTA\_WARN\_THRESHOLD='75'}

    \config{MAILQUOTA\_INCLUSIVE\_NEWMAIL}{MAILQUOTA\_INCLUSIVE\_NEWMAIL}{MAILQUOTAINCLUSIVENEWMAIL}
        Optionaler Parameter: Wird dieser Parameter auf 'yes' gesetzt,
        so wird eine neu eingehende Nachricht in die Mail-Quota-Berechnung
        einbezogen. Wird der Parameter auf 'no' gesetzt, so eine neu
        eingehende Nachricht nicht in die Mail-Quota-Berechnung einbezogen.

        G"ultige Werte: yes, no

        Standardeinstellung: \texttt{MAILQUOTA\_INCLUSIVE\_NEWMAIL='no'}

    \config{MAILQUOTA\_USER\_LAST\_IMPORT}{MAILQUOTA\_USER\_LAST\_IMPORT}{MAILQUOTAUSERLASTIMPORT}
        Wenn die Funktion zum Import der Mail- bzw. Systemanwender verwendet
        wurde, so enth"alt dieser Parameter den Datumsstempel des letzten Imports.

        G"ultige Werte: Text

        Beispiel: \texttt{MAILQUOTA\_USER\_LAST\_IMPORT='Sun Feb 19 13:42:12 CET 2006'}

    \config{MAILQUOTA\_USER\_N}{MAILQUOTA\_USER\_N}{MAILQUOTAUSERN}
        "Uber diesen Parameter wird die Anzahl der individuellen Anwendereintr"age
        festgelegt.\\
        \achtung{Durch Verwendung der Funktion zum Import der Mail- bzw.
        Systemanwender kann dieser Wert automatisch gesetzt werden!}

        G"ultige Werte: Zahlenwert

        Standardeinstellung: \texttt{MAILQUOTA\_USER\_N='0'}

    \config{MAILQUOTA\_USER\_x\_ACTIVE}{MAILQUOTA\_USER\_x\_ACTIVE}{MAILQUOTAUSERxACTIVE}
        Wird dieser Parameter auf den Wert 'yes' gesetzt, so wird der
        zugeh"orige Datensatz aktiviert, 'no' deaktiviert ihn.

        G"ultige Werte: yes, no

        Standardeinstellung: \texttt{MAILQUOTA\_USER\_1\_ACTIVE='no'}

    \config{MAILQUOTA\_USER\_x\_USER}{MAILQUOTA\_USER\_x\_USER}{MAILQUOTAUSERxUSER}
        "Uber diesen Parameter wird der Anwendername festgelegt, f"ur den
        Einstellungen definiert werden. Er muss einem g"ultigen Mail- bzw.
        Systemkonto entsprechen.\\
        \achtung{Durch Verwendung der Funktion zum Import der Mail- bzw.
        Systemanwender kann dieser Wert automatisch gesetzt werden!}

        G"ultige Werte: Usernamen

        Beispiel: \texttt{MAILQUOTA\_USER\_1\_USER='frank'}

    \config{MAILQUOTA\_USER\_x\_COMMENT}{MAILQUOTA\_USER\_x\_COMMENT}{MAILQUOTAUSERxCOMMENT}
        "Uber diesen Parameter kann ein Kommentar angegeben werden, der die
        Identifikation des Kontos erleichtert.\\
        \achtung{Durch Verwendung der Funktion zum Import der Mail- bzw.
        Systemanwender kann dieser Wert automatisch gesetzt werden!}

        G"ultige Werte: Text

        Beispiel: \texttt{MAILQUOTA\_USER\_1\_COMMENT='mein Kommentar'}

    \config{MAILQUOTA\_USER\_x\_QUOTA}{MAILQUOTA\_USER\_x\_QUOTA}{MAILQUOTAUSERxQUOTA}
        "Uber diesen Parameter wird der individuelle Wert f"ur die Mail-Quota
        konfiguriert. Der numerische Wert kann durch ein angeh"angtes
        'K' f"ur Kilo- oder 'M' f"ur Megabyte erweitert werden. Wird
        dieser Parameter auf 0 gesetzt, so werden die Mail-Quotas
        deaktiviert.

        G"ultige Werte: Speicherplatzangabe

        Beispieleinstellung: \texttt{MAILQUOTA\_USER\_1\_QUOTA='5M'}

    \config{MAILQUOTA\_USER\_x\_WARN\_THRESHOLD}{MAILQUOTA\_USER\_x\_WARN\_THRESHOLD}{MAILQUOTAUSERxWARNTHRESHOLD}
        "Uber diesen Parameter wird der individuelle Wert f"ur die Mail-Quota-
        Warnschwelle definiert. Zul"assig sind Werte zwischen 0 und 99,
        wobei 0 die Warnmeldungen deaktiviert.

        G"ultige Werte: Zahlenwert

        Standardeinstellung: \texttt{MAILQUOTA\_USER\_1\_WARN\_THRESHOLD='80'}

     \config{MAILQUOTA\_LOG\_COUNT}{MAILQUOTA\_LOG\_COUNT}{MAILQUOTALOGCOUNT}
        "Uber diesen Parameter wird eingestellt, wie viele Logdateien
        vorgehalten werden sollen. Wird dieser Wert "uberschritten, so
        wird jeweils die "alteste Logdatei gel"oscht.

        G"ultige Werte: Zahl

        Standardeinstellung: \texttt{MAILQUOTA\_LOG\_COUNT='5'}

    \config{MAILQUOTA\_LOG\_INTERVAL}{MAILQUOTA\_LOG\_INTERVAL}{MAILQUOTALOGINTERVAL}

        Dieser Parameter bestimmt in welchen Intervallen die Logdateien
        archiviert werden sollen. Zur Auswahl stehen die Schl"usselw"orter
        'daily' - t"aglich, 'weekly' - w"ochentlich und 'monthly' - monatlich.

        G"ultige Werte: daily, weekly, monthly

        Standardeinstellung: \texttt{MAILQUOTA\_LOG\_INTERVALL='monthly'}
\end{description}
