<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">%
% Achtung: Dateien muessen mit latin1-Encoding gespeichert werden!
% Attention: Files must be saved using latin1 encoding!
%

\chapter{Das ArchIMAP-Paket}

    Dieses Paket ist als Zusatzpaket zum Mail-Paket zu verstehen.
    Abgelegte Nachrichten werden, abh"angig von individuellen Einstellungen,
    in bestimmten Zeitintervallen archiviert oder gel"oscht.


\section{Die Einleitung}

    Durch einen Cronjob (periodische durchgef"uhrte Aufgabe) gesteuert werden
    die Postf"acher der Mail-Anwender, welche im Mail-Paket "uber die Parameter
    MAIL\_USER\_...  festgelegt wurden, nach deren individuellen Einstellungen
    archiviert bzw. gel"oscht. Voraussetzung hierf"ur ist, dass im Home-Verzeichnis
    eines Mail-Anwenders eine Datei mit Namen '.archimap-active' existiert.\\
    Als Selektionskriterium f"ur die Bearbeitung wird standardm"a"sig das in
    der 'From'-Zeile einer Nachricht enthaltene Datum zu Grunde gelegt. Soll
    alternativ das Datum aus der 'Date'-Zeile verwendet werden, so kann dies
    "uber den Parameter \jump{ARCHIMAPDEFAULTACTION}{ARCHIMAP\_DEFAULT\_ACTION}
    festgelegt werden.\\
    Falls zus"atzlich noch Public- (IMAP\_PUBLIC\_FOLDER\_...) oder
    Shared-Ordner (IMAP\_SHARED\_FOLDER\_...) definiert wurden, werden auch
    diese Ordner bei der Bearbeitung ber"ucksichtigt.\\
    Wird eine entsprechende .archimap-active-Datei gefunden, so wird diese um
    eventuell hinzugekommene Nachrichtendateien erg"anzt. Wird keine Datei
    gefunden, so wird auch keine Bearbeitung durchgef"uhrt.\\
    Ein Anwender kann diese Datei durch Eingabe des Befehls 'archimapinit'
    anlegen und dann gleich die Standardparameter anpassen oder auch mit einem
    Editor eine leere Datei erzeugen. Die Dateisyntax kann durch Eingabe des
    Befehls 'archimapcheck' gepr"uft werden.\\
    Der genaue Aufbau der Datei wird im Absatz 'Aufbau der Steuerdatei' beschrieben.\\
    Nach erfolgreicher Bearbeitung der Nachrichtendateien eines Mail-Anwenders
    werden die ausgef"uhrten Aktionen in einer Logdatei mit Namen 'archimap.log'
    festgehalten. Diese Datei wird im jeweiligen Home-Verzeichnis des Anwenders
    abgelegt und optional per E-Mail an den Anwender "ubermittelt.


\section{Die Funktionen}

    Das ArchIMAP-Paket besteht aus folgender Komponente:

    \begin{itemize}
        \item archmbox - ist ein Perl-Programm welches die Archivierung der Nachrichten durchf"uhrt.\\
            (\url{http://adc-archmbox.sourceforge.net/})
    \end{itemize}


\section{Die Voraussetzungen}

    Dieses Paket ben"otigt zur korrekten Funktion zwingend die installierten
    Paket ''Inet', 'Mail' und 'Perl'.


\section{Die Installation}

    Das ArchIMAP-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' -&gt; 'Goto mail
    modules' angesprochen und ist wie folgt aufgebaut:

    \begin{itemize}
    \item ArchIMAP administration
        \begin{itemize}
        \item View documentation: Anzeigen der Dokumentation
        \item Edit configuration: Bearbeiten der Konfiguration
        \item Advanced configuration file handling: Konfigurationen verwalten
        \item Force archiving (single/all): Archivierungslauf ansto"sen
        \item View log file: Anzeigen der Logdatei
        \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 gefragt, ob die Konfiguration aktiviert werden
    soll. Wird dies best"atigt, werden "uber ein Skript die Anpassungen umgehend
    wirksam gemacht. Es ist zu beachten, dass einige Programme eigenst"andig bei
    erneuter Aktivierung die Konfigurationsdatei neu einlesen. Somit f"uhrt die
    Beantwortung dieser Abfrage mit 'Nein' nur zu einem kurzen Aufschub der
    Aktivierung.


\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 /etc/config.d/archimap.

\section{Die Parameter}

\begin{description}
    \config{START\_ARCHIMAP}{START\_ARCHIMAP}{STARTARCHIMAP}
        Wird dieser Parameter auf 'yes' gestellt, so wird "uber einen
        Cronjob die automatisierte Bearbeitung der E-Mail-Verzeichnisse
        der Mail-Anwender angesto"sen. Wird der Parameter auf 'no'
        gesetzt, so wird die Archivierungsfunktion deaktiviert.

        G"ultige Werte: yes, no

        Standardeinstellung: \texttt{START\_ARCHIMAP='no'}
        
    \config{ARCHIMAP\_TMP\_PATH}{ARCHIMAP\_TMP\_PATH}{ARCHIMAPTMPPATH}
        "Uber diesen Parameter kann man das tempor"are Verzeichnis anpassen, 
        welches vom Programm 'archmbox' verwendet wird.

        G"ultige Werte: absoluter Pfad

        Standardeinstellung: \texttt{ARCHIMAP\_TMP\_PATH='/tmp'}

    \config{ARCHIMAP\_DEFAULT\_ARCHIVE\_FOLDER}{ARCHIMAP\_DEFAULT\_ARCHIVE\_FOLDER}{ARCHIMAPDEFAULTARCHIVEFOLDER}
        "Uber diesen Parameter wird ein Ordner angegeben, unter dem die
        zu archivierenden Nachrichten im Mail-Verzeichnis des Anwenders
        abgelegt werden sollen. Bei Verwendung des Standardwertes
        'Archiv' wird also z.B. der Ordner '$\sim$/.imapmail/Sent'
        nach '$\sim$/.imapmail/Archiv/Sent.archived' gesichert.\\
        Beginnt der Eintrag mit einem '/', so wird ein absoluter Pfad 
		angegeben, der sich auch au"serhalb des Home-Verzeichnisses
		eines Anwenders befinden kann. Zu beachten ist hierbei jedoch, 
		dass es sich um einen einmaligen Verzeichnispfad handeln muss,
        welcher nicht schon von einem anderen Anwender verwendet wird
        und auf den der Anwender Schreibrechte besitzt. Ansonsten
        kann dies dazu f"uhren, dass E-Mail unterschiedlicher Anwender in
        einem Verzeichnis gespeichert werden bzw. es zu Schreibfehlern
        kommt.\\
        Diese Einstellung kann von jedem Mail-Anwender individuell angepasst
        werden.\\

        G"ultige Werte: Verzeichnis oder Pfadangabe

        Standardeinstellung: \texttt{ARCHIMAP\_DEFAULT\_ARCHIVE\_FOLDER='Archiv'}

    \config{ARCHIMAP\_DEFAULT\_ARCHIVE\_TYPE}{ARCHIMAP\_DEFAULT\_ARCHIVE\_TYPE}{ARCHIMAPDEFAULTARCHIVETYPE}
        "Uber diesen Parameter wird festgelegt, nach welchen Kriterien 
		standardm"a"sig die Archivdatei benannt werden soll.\\
        Wird der Parameter \texttt{'default'} verwendet, so wird der
        Namenszusatz der Datei auf '.archived' gesetzt.\\
        Wird der Parameter \texttt{'yearly'} verwendet, so wird der
        Namenszusatz der Datei in Abh"angigkeit des Empfangsjahres gesetzt.
        Beispiel: '.2004'\\
        Wird der Parameter \texttt{'monthly'} verwendet, so wird der
        Namenszusatz der Datei in Abh"angigkeit des Empfangsjahres und -monates
        gesetzt. Beispiel: '.2004-03'\\
        Wird der Parameter \texttt{'daily'} verwendet, so wird der
        Namenszusatz der Datei in Abh"angigkeit des Empfangsjahres, -monates und
        -tages gesetzt. Beispiel: '.2004-03-14'\\

        G"ultige Werte: default, yearly, monthly, daily

        Standardeinstellung: \texttt{ARCHIMAP\_DEFAULT\_ARCHIVE\_TYPE='default'}

    \config{ARCHIMAP\_DEFAULT\_ACTION}{ARCHIMAP\_DEFAULT\_ACTION}{ARCHIMAPDEFAULTACTION}
        "Uber diesen Parameter wird festgelegt, welche Aktion standardm"a"sig
        auf neue Nachrichtendateien angewendet werden soll. Dabei wird bei
        Angabe von 'none' die Bearbeitung "ubersprungen, bei Angabe von
        'archive' werden Nachrichten archiviert, bei Angabe von 'copy' werden
        Nachrichten kopiert, bei Angabe von 'kill' werden Nachrichten gel"oscht
        und bei Angabe von 'list' wird nur angezeigt wie viele Nachrichten
        gegebenenfalls bearbeitet w"urden.\\
        Diese Einstellung kann von jedem Mail-Anwender individuell angepasst
        werden.

		Wird den Parametern ein '-date' angeh"angt, so wird f"ur die Bearbeitung
        der Nachrichten der Date-Zeile anstelle des Erstellungsdatums der
        Nachricht verwendet.

		\achtung{Insbesondere der Parameter 'kill' darf nur mit gro"ser
                 Vorsicht benutzt werden, da hierdurch die Nachrichtendateien
				 der Anwender ohne R"uckfrage gel"oscht werden k"onnen!}

        G"ultige Werte: none, archive$[$-date$]$, copy$[$-date$]$, kill$[$-date$]$, list$[$-date$]$

        Standardeinstellung: \texttt{ARCHIMAP\_DEFAULT\_ACTION='none'}

    \config{ARCHIMAP\_DEFAULT\_TIMESPAN}{ARCHIMAP\_DEFAULT\_TIMESPAN}{ARCHIMAPDEFAULTTIMESPAN}
        "Uber diesen Parameter wird angegeben, nach wie vielen Tagen 
		standardm"a"sig die Nachrichten bearbeitet werden sollen. Im 
		Beispiel wird davon ausgegangen, dass alle Nachrichten bearbeitet 
		werden sollen welche "alter als 90 Tage sind. Wird 'all' 
		angegeben, so werden generell alle Nachrichten bearbeitet. Diese 
		Einstellung kann von jedem Mail-Anwender individuell angepasst 
		werden.

        G"ultige Werte: Anzahl von Tagen oder 'all'

        Standardeinstellung: \texttt{ARCHIMAP\_DEFAULT\_TIMESPAN='90'}

    \config{ARCHIMAP\_EXCLUDE\_FOLDERS}{ARCHIMAP\_EXCLUDE\_FOLDERS}{ARCHIMAPEXCLUDEFOLDERS}
        Dieser Parameter enth"alt eine Liste von Ordnern, welche von der
        Archivierung ausgeschlossen werden, da deren Archivierung nicht 
		unbedingt sinnvoll ist. Die Eintr"age m"ussen jeweils durch einen 
		Doppelpunkt voneinander getrennt werden.
    
        G"ultige Werte: Verzeichnisnamen
    
        Standardeinstellung: \texttt{ARCHIMAP\_EXCLUDE\_FOLDERS='INBOX:Draft:Templates:Trash'}

    \config{ARCHIMAP\_RUN\_ARCHIVE\_SCRIPTS}{ARCHIMAP\_RUN\_ARCHIVE\_SCRIPTS}{ARCHIMAPRUNARCHIVESCRIPTS}
        "Uber diesen Parameter wird festgelegt, ob ein Pre- bzw. Post-
		Archivierungsskript ausgef"uhrt werden soll. Dies kann sinnvoll 
		sein, wenn man Daten z.B. auf ein Laufwerk sichern will zu welchem 
		erst eine Verbindung hergestellt werden muss. Die Ausf"uhrung 
		der Skripte wird als erfolgreich angesehen, wenn sie nach der
        Ausf"uhrung den Wert '0' zur"uckgeben.

        Die Namen der Skripte lauten 'pre\_archive\_script.sh' und
        'post\_archive\_script.sh' und sie befinden sich im Verzeichnis
        \texttt{/var/archimap/bin/}.

        G"ultige Werte: yes, no

        Standardeinstellung: \texttt{ARCHIMAP\_RUN\_ARCHIVE\_SCRIPTS='no'}

    \config{ARCHIMAP\_CRON}{ARCHIMAP\_CRON}{ARCHIMAPCRON}
        Wird dieser Parameter auf 'yes' gestellt, so erfolgt eine 
		automatisierte Archivierung in dem "uber die Variable 
		ARCHIMAP\_CRON\_SCHEDULE vorgegebenen Zeitintervall. Die 
		Einstellung 'no' deaktiviert die automatische Archivierung.

        G"ultige Werte: yes, no

        Standardeinstellung: \texttt{ARCHIMAP\_CRON='yes'}

    \config{ARCHIMAP\_CRON\_SCHEDULE}{ARCHIMAP\_CRON\_SCHEDULE}{ARCHIMAPCRONSCHEDULE}
        Hier wird festgelegt zu welchem Zeitpunkt bzw. in welchem 
		Intervall eine Archivierung der IMAP-Maildateien angesto"sen 
		werden soll. Diese Funktion ist nur verf"ugbar, wenn der 
		Parameter ARCHIMAP\_CRON='yes' gesetzt wurde. Die f"unf 
		Teilparameter haben dabei folgende Bedeutung:
		
        1 - Minuten, 2 - Stunden, 3 - Tag des Monats, 4 - Monat, 5 - Wochentag.
        
		D.h.  bei Verwendung der Standardeinstellung wird jeweils am 
		Samstag um 01:07h die Archivierung gestartet. Wer N"aheres "uber 
		die verwendete Befehlssyntax erfahren m"ochte, sollte im Internet 
		nach 'man' und 'crontab' suchen.

        G"ultige Werte: Crontab-spezifischer Parametereintrag

        Standardeinstellungen: \texttt{ARCHIMAP\_CRON\_SCHEDULE='7 1 * * 6'}

    \config{ARCHIMAP\_RESULT\_INFOMAIL}{ARCHIMAP\_RESULT\_INFOMAIL}{ARCHIMAPRESULTINFOMAIL}
        Wird dieser Parameter auf 'yes' gestellt, so wird automatisch das
        Ergebnis eines Archivierungslaufes an den jeweiligen Mail-Anwender
        verschickt. Die Einstellung 'no' deaktiviert den automatischen Versand
        einer solchen Nachricht. Diese Einstellung kann von jedem Mail-Anwender
        individuell angepasst werden.

        G"ultige Werte: yes, no

        Standardeinstellung: \texttt{ARCHIMAP\_RESULT\_INFOMAIL='yes'}

    \config{ARCHIMAP\_RESULT\_INFOMAIL\_SENDTO (optional)}{ARCHIMAP\_RESULT\_INFOMAIL\_SENDTO}{ARCHIMAPRESULTINFOMAILSENDTO}
        Wird dieser Parameter in die Konfigurationsdatei eingef"ugt und mit
        einer E-Mail-Adresse versehen, so wird bei gleichzeitig gesetztem
        Parameter ARCHIMAP\_RESULT\_INFOMAIL='yes' eine .forward-Datei f"ur
        die Postf"acher 'imappublic' und 'imapshared' erstellt. "Uber diese
        Datei wird gesteuert, dass das Ergebnis eines Archivierungslaufes
        f"ur diese allgemeinen Postf"acher stellvertretend an die angegebene
        E-Mail-Adresse geschickt wird. Diese Einstellung kann f"ur die genannten
        Postf"acher auch individuell angepasst werden, bei allen anderen
        Postf"achern bleibt dieser Parameter wirkungslos.
 
        G"ultige Werte: g"ultige Mailadresse
 
        Beispiel: \texttt{ARCHIMAP\_RESULT\_INFOMAIL\_SENDTO=postmaster@domain.lan}
 
        Standardeinstellung: \texttt{ARCHIMAP\_RESULT\_INFOMAIL\_SENDTO=}
\end{description}

\section{Der Aufbau der Steuerdatei}

    Bei der erstmaligen Bearbeitung der Nachrichtendateien wird eine Datei mit
    Namen '.archimap-active' im Home-Verzeichnis eines jeden Anwenders abgelegt.
    Diese Datei steuert welche Nachrichtendateien bearbeitet und welche Aktionen
    in welchem Intervall ausgef"uhrt werden sollen. Die Standardvorgaben f"ur
    das Anlegen dieser Datei werden erstmalig vom Administrator eingestellt und
    k"onnen vom Anwender individuell angepasst werden. Es ist zu beachten, dass
    die erste Zeile unbedingt '\# defaults - version:1' hei"st, andernfalls wird
    die Konfigurationsdatei nicht erkannt.

    Beispiel:

    \begin{verbatim}
# defaults - version:1
ARCHIMAP_DEFAULT_ARCHIVE_FOLDER=Archiv
ARCHIMAP_DEFAULT_ARCHIVE_TYPE=default
ARCHIMAP_DEFAULT_ACTION=none
ARCHIMAP_DEFAULT_TIMESPAN=30
ARCHIMAP_RESULT_INFOMAIL=yes
ARCHIMAP_RESULT_INFOMAIL_SENDTO=
#file/dir:name:action:days:type:comment
dir:/home/frank/.imapmail:
file:/home/frank/.imapmail/Sent:archive:60:yearly
dir:/home/frank/.imapmail/Ablage_Mailinglisten:
file:/home/frank/.imapmail/Ablage_Mailinglisten/FLI4L_ML:kill:90:default
file:/home/frank/.imapmail/Ablage_Mailinglisten/EISFAIR_ML:kill:90:default
dir:/home/frank/.imapmail/Ablage_Ebay:
file:/home/frank/.imapmail/Ablage_Ebay/Ebay-kaufen:none:30:default
file:/home/frank/.imapmail/Ablage_Ebay/Ebay-verkaufen:none:30:default
    \end{verbatim}

    Die ersten sechs Parameter geben die Standardwerte f"ur neu hinzukommende Ordner
    an und "uberschreiben die Vorgaben des Administrators. Auf die Funktion der
    einzelnen Parameter wurde im Abschnitt 'Die Konfigurationsdatei' detailliert
    eingegangen.\\
    Die darauf folgenden Zeilen geben die Ordnerstruktur und die darin enthaltenen
    Nachrichtendateien an. Der Aufbau der Zeilen erfolgt dabei nach dem Schema
    '\texttt{file/dir:name:action:days:type:comment}'.\\
    Die Parameter werden jeweils durch einen Doppelpunkt voneinander getrennt.


    \begin{verbatim}
Parameter      gueltige Werte
---------      --------------
dir/file       dir  - Verzeichniseintrag, kommt immer vor einem
                      Dateieintrag
               file - Dateieintrag

name           Pfad und Name der Mail-Datei

action         none    - Mail nicht bearbeiten
               archive - Mail archivieren
               copy    - Mail kopieren
               kill    - Mail loeschen

days           Angabe der Tage nach denen Mail archiviert oder geloescht
               werden soll

type           default - '.archived' an die Archivdatei anhaengen
               yearly  - z.B. '.2004' an die Archivdatei anhaengen
               monthly - z.B. '.2004-03' an die Archivdatei anhaengen
               daily   - z.B. '.2004-03-14' an die Archivdatei anhaengen

comment        Angabe eines individuellen Kommentars (optional)
    \end{verbatim}


\section{Verschiedenes}

\begin{description}
    \config{Public- und Shared-Ordner}{Public- und Shared-Ordner}{PublicundSharedOrdner}
        Will man zum Beispiel auch den Inhalt von Public- oder Shared-Ordnern
        bearbeiten, so ist hier die Vorgehensweise etwas anders, da es sich
        nicht um vollwertige Systemanwender handelt. Am Beispiel eines "offentlichen
        Spam-Ordners m"ochte ich dies verdeutlichen.

        Voraussetzung:
        
        \begin{itemize}
            \item[1] Einen Public-Ordner im Mail-Paket anlegen:

                IMAP\_PUBLIC\_FOLDER\_N='1'\\
                IMAP\_PUBLIC\_FOLDER\_1\_NAME='Spam-Mail'\\
                IMAP\_PUBLIC\_FOLDER\_1\_USERGROUP=''\\

            \item[2] Exiscan-Konfiguration im Mail-Paket modifizieren:

                EXISCAN\_SPAMD\_ENABLED='yes'\\
                EXISCAN\_SPAMD\_ACTION='redirect spam-mail@domain.de'\\

            \item[3] Im Verzeichnis /home/imappublic' eine archimap-Datei, durch
                Aufruf von 'archimapinit imappublic' anlegen und diese danach entsprechend
                anpassen.
        \end{itemize}

\end{description}
</pre></body></html>