Das ArchIMAP-Paket Dieses Paket ist als Zusatzpaket zum Mail-Paket zu verstehen. Abgelegte Nachrichten werden, abhaengig von individuellen Einstellungen, in bestimmten Zeitintervallen archiviert oder geloescht. Die Einleitung Durch einen Cronjob (periodische durchgefuehrte Aufgabe) gesteuert werden die Postfaecher der Mail-Anwender, welche im Mail-Paket ueber die Parameter MAIL_USER_... festgelegt wurden, nach deren individuellen Einstellungen archiviert bzw. geloescht. Voraussetzung hierfuer ist, dass im Home-Verzeichnis eines Mail-Anwenders eine Datei mit Namen '.archimap-active' existiert. Als Selektionskriterium fuer die Bearbeitung wird standardmaessig 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 ueber den Parameter [1]ARCHIMAP_DEFAULT_ACTION festgelegt werden. Falls zusaetzlich noch Public- (IMAP_PUBLIC_FOLDER_...) oder Shared-Ordner (IMAP_SHARED_FOLDER_...) definiert wurden, werden auch diese Ordner bei der Bearbeitung beruecksichtigt. Wird eine entsprechende .archimap-active-Datei gefunden, so wird diese um eventuell hinzugekommene Nachrichtendateien ergaenzt. Wird keine Datei gefunden, so wird auch keine Bearbeitung durchgefuehrt. 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' geprueft werden. Der genaue Aufbau der Datei wird im Absatz 'Aufbau der Steuerdatei' beschrieben. Nach erfolgreicher Bearbeitung der Nachrichtendateien eines Mail-Anwenders werden die ausgefuehrten 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 uebermittelt. Die Funktionen Das ArchIMAP-Paket besteht aus folgender Komponente: * archmbox - ist ein Perl-Programm welches die Archivierung der Nachrichten durchfuehrt. ([2]http://adc-archmbox.sourceforge.net/) Die Voraussetzungen Dieses Paket benoetigt zur korrekten Funktion zwingend die installierten Paket ''Inet', 'Mail' und 'Perl'. Die Installation Das ArchIMAP-Paket wird ueber das Setup-Menue installiert. Wird eine aeltere 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 benoetigten Programme gestartet. Das Menue im Setup-Programm Das Menue im Setup-Programm wird ueber 'Mail Services' -> 'Goto mail modules' angesprochen und ist wie folgt aufgebaut: * ArchIMAP administration + View documentation: Anzeigen der Dokumentation + Edit configuration: Bearbeiten der Konfiguration + Advanced configuration file handling: Konfigurationen verwalten + Force archiving (single/all): Archivierungslauf anstossen + View log file: Anzeigen der Logdatei + Return: Untermenue verlassen * Return: Untermenue verlassen Die Menuepunkte duerften selbsterklaerend sein, da sie keinerlei weitere Eingaben erwarten. Aus diesem Grund wird auf deren Funktion nicht weiter eingegangen. Die Aenderung der Konfiguration Die Konfiguration kann ueber den Menuepunkt 'Edit configuration' geaendert werden. Standardmaessig wird der Editor aufgerufen, der in der Environment- Konfiguration ueber die Variable 'EDITOR' festgelegt wurde. Nachdem der Editor beendet wurde wird gefragt, ob die Konfiguration aktiviert werden soll. Wird dies bestaetigt, werden ueber ein Skript die Anpassungen umgehend wirksam gemacht. Es ist zu beachten, dass einige Programme eigenstaendig bei erneuter Aktivierung die Konfigurationsdatei neu einlesen. Somit fuehrt die Beantwortung dieser Abfrage mit 'Nein' nur zu einem kurzen Aufschub der Aktivierung. Die Konfigurationsdatei In der Konfigurationsdatei, die ueber das Menue zugaenglich ist, sind folgende Parameter vorhanden; wer sie von Hand editieren will findet sie unter /etc/config.d/archimap. Die Parameter START_ARCHIMAP Wird dieser Parameter auf 'yes' gestellt, so wird ueber einen Cronjob die automatisierte Bearbeitung der E-Mail-Verzeichnisse der Mail-Anwender angestossen. Wird der Parameter auf 'no' gesetzt, so wird die Archivierungsfunktion deaktiviert. Gueltige Werte: yes, no Standardeinstellung: START_ARCHIMAP='no' ARCHIMAP_TMP_PATH Ueber diesen Parameter kann man das temporaere Verzeichnis anpassen, welches vom Programm 'archmbox' verwendet wird. Gueltige Werte: absoluter Pfad Standardeinstellung: ARCHIMAP_TMP_PATH='/tmp' ARCHIMAP_DEFAULT_ARCHIVE_FOLDER Ueber 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 '/.imapmail/Sent' nach '/.imapmail/Archiv/Sent.archived' gesichert. Beginnt der Eintrag mit einem '/', so wird ein absoluter Pfad angegeben, der sich auch ausserhalb 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 fuehren, 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. Gueltige Werte: Verzeichnis oder Pfadangabe Standardeinstellung: ARCHIMAP_DEFAULT_ARCHIVE_FOLDER='Archiv' ARCHIMAP_DEFAULT_ARCHIVE_TYPE Ueber diesen Parameter wird festgelegt, nach welchen Kriterien standardmaessig die Archivdatei benannt werden soll. Wird der Parameter 'default' verwendet, so wird der Namenszusatz der Datei auf '.archived' gesetzt. Wird der Parameter 'yearly' verwendet, so wird der Namenszusatz der Datei in Abhaengigkeit des Empfangsjahres gesetzt. Beispiel: '.2004' Wird der Parameter 'monthly' verwendet, so wird der Namenszusatz der Datei in Abhaengigkeit des Empfangsjahres und -monates gesetzt. Beispiel: '.2004-03' Wird der Parameter 'daily' verwendet, so wird der Namenszusatz der Datei in Abhaengigkeit des Empfangsjahres, -monates und -tages gesetzt. Beispiel: '.2004-03-14' Gueltige Werte: default, yearly, monthly, daily Standardeinstellung: ARCHIMAP_DEFAULT_ARCHIVE_TYPE='default' ARCHIMAP_DEFAULT_ACTION Ueber diesen Parameter wird festgelegt, welche Aktion standardmaessig auf neue Nachrichtendateien angewendet werden soll. Dabei wird bei Angabe von 'none' die Bearbeitung uebersprungen, bei Angabe von 'archive' werden Nachrichten archiviert, bei Angabe von 'copy' werden Nachrichten kopiert, bei Angabe von 'kill' werden Nachrichten geloescht und bei Angabe von 'list' wird nur angezeigt wie viele Nachrichten gegebenenfalls bearbeitet wuerden. Diese Einstellung kann von jedem Mail-Anwender individuell angepasst werden. Wird den Parametern ein '-date' angehaengt, so wird fuer die Bearbeitung der Nachrichten die Date-Zeile anstelle des Erstellungsdatums der Nachricht verwendet. ACHTUNG Insbesondere der Parameter 'kill' darf nur mit grosser Vorsicht benutzt werden, da hierdurch die Nachrichtendateien der Anwender ohne Rueckfrage geloescht werden koennen! Gueltige Werte: none, archive[-date], copy[-date], kill[-date], list[-date] Standardeinstellung: ARCHIMAP_DEFAULT_ACTION='none' ARCHIMAP_DEFAULT_TIMESPAN Ueber diesen Parameter wird angegeben, nach wie vielen Tagen standardmaessig die Nachrichten bearbeitet werden sollen. Im Beispiel wird davon ausgegangen, dass alle Nachrichten bearbeitet werden sollen welche aelter als 90 Tage sind. Wird 'all' angegeben, so werden generell alle Nachrichten bearbeitet. Diese Einstellung kann von jedem Mail-Anwender individuell angepasst werden. Gueltige Werte: Anzahl von Tagen oder 'all' Standardeinstellung: ARCHIMAP_DEFAULT_TIMESPAN='90' ARCHIMAP_EXCLUDE_FOLDERS Dieser Parameter enthaelt eine Liste von Ordnern, welche von der Archivierung ausgeschlossen werden, da deren Archivierung nicht unbedingt sinnvoll ist. Die Eintraege muessen jeweils durch einen Doppelpunkt voneinander getrennt werden. Gueltige Werte: Verzeichnisnamen Standardeinstellung: ARCHIMAP_EXCLUDE_FOLDERS='INBOX:Draft:Templates:Trash' ARCHIMAP_RUN_ARCHIVE_SCRIPTS Ueber diesen Parameter wird festgelegt, ob ein Pre- bzw. Post- Archivierungsskript ausgefuehrt 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 Ausfuehrung der Skripte wird als erfolgreich angesehen, wenn sie nach der Ausfuehrung den Wert '0' zurueckgeben. Die Namen der Skripte lauten 'pre_archive_script.sh' und 'post_archive_script.sh' und sie befinden sich bei eisfair-1 im Verzeichnis /var/archimap/bin/ und bei eisfair-2 im Verzeichnis /data/packages. Gueltige Werte: yes, no Standardeinstellung: ARCHIMAP_RUN_ARCHIVE_SCRIPTS='no' ARCHIMAP_CRON Wird dieser Parameter auf 'yes' gestellt, so erfolgt eine automatisierte Archivierung in dem ueber die Variable ARCHIMAP_CRON_SCHEDULE vorgegebenen Zeitintervall. Die Einstellung 'no' deaktiviert die automatische Archivierung. Gueltige Werte: yes, no Standardeinstellung: ARCHIMAP_CRON='yes' ARCHIMAP_CRON_SCHEDULE Hier wird festgelegt zu welchem Zeitpunkt bzw. in welchem Intervall eine Archivierung der IMAP-Maildateien angestossen werden soll. Diese Funktion ist nur verfuegbar, wenn der Parameter ARCHIMAP_CRON='yes' gesetzt wurde. Die fuenf 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 Naeheres ueber die verwendete Befehlssyntax erfahren moechte, sollte im Internet nach 'man' und 'crontab' suchen. Gueltige Werte: Crontab-spezifischer Parametereintrag Standardeinstellungen: ARCHIMAP_CRON_SCHEDULE='7 1 * * 6' ARCHIMAP_RESULT_INFOMAIL 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. Gueltige Werte: yes, no Standardeinstellung: ARCHIMAP_RESULT_INFOMAIL='yes' ARCHIMAP_RESULT_INFOMAIL_SENDTO (optional) Wird dieser Parameter in die Konfigurationsdatei eingefuegt und mit einer E-Mail-Adresse versehen, so wird bei gleichzeitig gesetztem Parameter ARCHIMAP_RESULT_INFOMAIL='yes' eine .forward-Datei fuer die Postfaecher 'imappublic' und 'imapshared' erstellt. Ueber diese Datei wird gesteuert, dass das Ergebnis eines Archivierungslaufes fuer diese allgemeinen Postfaecher stellvertretend an die angegebene E-Mail-Adresse geschickt wird. Diese Einstellung kann fuer die genannten Postfaecher auch individuell angepasst werden, bei allen anderen Postfaechern bleibt dieser Parameter wirkungslos. Gueltige Werte: gueltige Mailadresse Beispiel: ARCHIMAP_RESULT_INFOMAIL_SENDTO=postmaster@domain.lan Standardeinstellung: ARCHIMAP_RESULT_INFOMAIL_SENDTO= 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 ausgefuehrt werden sollen. Die Standardvorgaben fuer das Anlegen dieser Datei werden erstmalig vom Administrator eingestellt und koennen vom Anwender individuell angepasst werden. Es ist zu beachten, dass die erste Zeile unbedingt '# defaults - version:1' heisst, andernfalls wird die Konfigurationsdatei nicht erkannt. Beispiel: # 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 Die ersten sechs Parameter geben die Standardwerte fuer neu hinzukommende Ordner an und ueberschreiben 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 'file/dir:name:action:days:type:comment'. Die Parameter werden jeweils durch einen Doppelpunkt voneinander getrennt. 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) Verschiedenes Public- und Shared-Ordner 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 oeffentlichen Spam-Ordners moechte ich dies verdeutlichen. Voraussetzung: 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='' 2 Exiscan-Konfiguration im Mail-Paket modifizieren: EXISCAN_SPAMD_ENABLED='yes' EXISCAN_SPAMD_ACTION='redirect spam-mail@domain.de' 3 Im Verzeichnis /home/imappublic' eine archimap-Datei, durch Aufruf von 'archimapinit imappublic' anlegen und diese danach entsprechend anpassen. __________________________________________________________________ Juergen Edner 2012-05-22