projekt kivitendo

<para>Die prinzipielle Idee des Hintergrund-Jobs <literal>ImportRecordEmails</literal> ist es auf einen spezifischen IMAP-Ordner zuzugreifen und unterhalb diesen Ordners alle E-Mails in kivitendo zu importieren. Der Job ist transaktionssicher, d.h. entweder können alle E-Mails zum Zeitpunkt des Jobs importiert werden oder es wird überhaupt keine importiert.</para><para>Die eindeutige Kennzeichnung um Duplikate beim Import zu vermeiden ist die UID der E-Mail auf dem IMAP-Server, dies ist solange stabil, solange der Provider nicht gewechselt wird, bzw. die E-Mails nicht auf einen anderen IMAP-Server migrieren.</para><para>Zu guter Letzt kann der Job auch noch automatisch Verarbeitungen mit dem Anhängen der E-Mail direkt beim Import durchführen, bspw. ZUGFeRD konforme PDFs automatisch verbuchen.</para>

 <para>Die prinzipiellen IMAP-Zugangsdaten können vollständig über das Feld Daten konfiguriert werden und sind wie folgt definiert:</para>

    <para>Um das ganze Verfahren komfortabler zu optimieren oder Fehlimporte wieder zu löschen stehen folgende optionale Parameter zu Verfügung:</para>

            <para><literal>imported_imap_flag:</literal> Das hier eingetragenen Flag wird nach dem Verarbeiten in der E-Mail auf den IMAP-Server gesetzt.</para>

          </listitem>

          <listitem>

            <para><literal>not_imported_imap_flag:</literal> Das hier eingetragenen Flag wird bei erfolglosen Importieren auf dem IMAP-Server gesetzt und ist hilfreich um die Fehlerfälle bei großem Datenimporten schneller einzugrenzen.</para>

            <para><literal>processed_imap_flag:</literal> Das hier eingetragenen Flag wird nach dem erfolgreichen Verarbeiten an der E-Mail gesetzt.</para>

          </listitem>

          <listitem>

            <para><literal>not_processed_imap_flag:</literal> Dieses Flag wird gesetzt, falls die E-Mail nicht erfolgreich verarbeitet werden konnte (Verarbeitungsprozeß ist in <literal>process_imported_emails</literal> definiert.</para>

            <para><literal>skip_broken_mime_mails:</literal> Bricht den Import-Lauf NICHT ab, falls einige Mails nicht MIME-konform "zerlegt" werden können. Default: 0</para>

  <note>Hilfreich ist dieses Skript was die Flags beispielhaft für einen IMAP-Ordner 'Eingangsrechung' ausliest. Entsprechend die <literal>$GROSSBUCHSTABEN</literal> mit eigenen Werten ersetzen: <programlisting>

#!/usr/bin/perl

use strict;

use warnings;

use Mail::IMAPClient;

my $imap = Mail::IMAPClient->new(

  Server   => '$SERVER',

  User     => '$USER',

  Password => '$PASS',

  Ssl      => 1,

  Uid      => 1,

);

$imap->select("INBOX.Eingangsrechnung")

  or die "Select  error: ", $imap->LastError, "\n";

# get the flags for every message in my 'Eingangsrechner' folder

my $flaghash = $imap->flags( scalar( $imap->search("ALL") ) );

# pump through sorted hash keys to print results:

for my $k (keys %$flaghash) {

    # print: Message 1: \Flag1, \Flag2, \Flag3

    print "Message $k:\t", join( ", ", @{$flaghash->{$k}} ), "\n";

}

</programlisting></note>

<note>

Eine beispielhafte Konfiguration im YAML-Format für das Feld 'Daten' im Hintergrund-Job könnte bspw. so aussehen.

Enthalten sind alle aktuell bekannten Parameter mit entsprechenden sinnvollen Standardwerten, bis auf die Werte der IMAP-Flags (s.a. vorherige Notiz), sodass die Konfiguration als einfachen Start zum Experimentieren direkt kopiert werden kann:

imported_imap_flag: in_kivitendo_importiert

not_imported_imap_flag: nicht_importiert

process_imported_emails: zugferd

skip_broken_mime_mails: 0

        </note>