Flower

← Alle Module · Kommunikation & Netz

imap

Greift direkt auf ein E-Mail-Postfach per IMAP zu: Nachrichten auflisten und lesen, als gelesen/ungelesen markieren, Anhänge speichern, Mails verschieben oder löschen sowie Postfach-Ordner verwalten. Praktisch, um eingehende E-Mails automatisch zu sortieren, abzulegen oder weiterzuverarbeiten.

Block-Einstellungen

Gelten für den ganzen Modul-Block (im Editor oben im Inspektor, in YAML direkt unter dem Modulnamen).

FeldTypPflichtBeschreibung
serverTextAdresse des IMAP-Servers (Standard: localhost).
portZahlServer-Port (Standard: 993).
sslWahrheitVerschlüsselte Verbindung per TLS verwenden (Standard: ja).
nutzerTextAnmeldename / E-Mail-Adresse für das Postfach.
passwort-credObjektVerweis auf das hinterlegte Passwort (Credential-Block mit Schlüssel), statt das Passwort im Klartext anzugeben.
ordnerTextPostfach-Ordner, auf dem die Aktionen arbeiten (Standard: INBOX).

Aktionen

listelesend

Listet die Mails des konfigurierten Ordners auf, optional nur ungelesene und auf eine Höchstzahl begrenzt.

Eingaben

FeldTypPflichtBeschreibung
ungelesen-onlyWahrheitNur ungelesene Mails einbeziehen (Standard: nein).
maxZahlMaximale Anzahl zurückgegebener Mails (Standard: 50).

Ausgaben (über ergebnis:)

mailsListe der gefundenen Mails, je mit mail-id, von, an, cc, bcc, betreff, text, inhalt-html, datum und anhang-namen.

lesenlesend

Liest eine einzelne Mail anhand ihrer UID vollständig aus.

Eingaben

FeldTypPflichtBeschreibung
idZahljaUID der zu lesenden Mail.

Ausgaben (über ergebnis:)

mailDie Mail mit allen Feldern (von, an, betreff, text, inhalt-html, datum, anhang-namen …) oder leer, wenn nicht gefunden.

als-gelesen-markierenverändernd

Setzt das Gelesen-Kennzeichen einer Mail.

Eingaben

FeldTypPflichtBeschreibung
idZahljaUID der zu markierenden Mail.

als-ungelesen-markierenverändernd

Entfernt das Gelesen-Kennzeichen einer Mail.

Eingaben

FeldTypPflichtBeschreibung
idZahljaUID der zu markierenden Mail.

anhänge-speichernverändernd

Speichert die Anhänge einer Mail in einen Zielordner auf dem Dateisystem, optional gefiltert per Namensmuster.

Eingaben

FeldTypPflichtBeschreibung
idZahljaUID der Mail, deren Anhänge gespeichert werden.
ziel-ordnerTextjaOrdner, in den die Anhänge geschrieben werden (wird bei Bedarf angelegt).
filterListeOptionale Glob-Muster (z.B. *.pdf); nur passende Anhänge werden gespeichert.

Ausgaben (über ergebnis:)

dateienListe der geschriebenen Datei-Pfade.

ordner-listenlesend

Listet alle Ordner des Postfachs auf.

Ausgaben (über ergebnis:)

ordnerListe aller Ordnernamen im Postfach.

ordner-anlegenverändernd

Legt einen neuen Ordner im Postfach an.

Eingaben

FeldTypPflichtBeschreibung
nameTextjaName des anzulegenden Ordners.

ordner-löschenverändernd

Löscht einen Ordner im Postfach.

Eingaben

FeldTypPflichtBeschreibung
nameTextjaName des zu löschenden Ordners.

verschiebenverändernd

Verschiebt eine Mail aus dem aktuellen Ordner in einen Zielordner.

Eingaben

FeldTypPflichtBeschreibung
idZahljaUID der zu verschiebenden Mail.
ziel-ordnerTextjaZielordner im Postfach.

loeschenverändernd

Löscht eine Mail; standardmäßig in den Papierkorb, mit endgültig=ja unwiderruflich.

Eingaben

FeldTypPflichtBeschreibung
idZahljaUID der zu löschenden Mail.
endgültigWahrheitBei ja sofort und unwiderruflich löschen statt in den Papierkorb (Standard: nein).

Beispiele

Ungelesene Mails auflisten

Holt die neuesten ungelesenen Mails aus dem Posteingang, begrenzt auf 20 Stück.

imap
liste
ungelesen-onlyja
max20
ergebnisneue_mails
- imap:
    server: "imap.firma.de"
    nutzer: "buero@firma.de"
    passwort-cred:
      schlüssel: "IMAP_PASSWORT"
    ordner: "INBOX"
    aktionen:
      - liste:
          ungelesen-only: ja
          max: 20
          ergebnis: neue_mails

Anhänge ablegen und Mail archivieren

Speichert die PDF-Anhänge einer Mail in einen Netzlaufwerk-Ordner und verschiebt die Mail danach ins Archiv.

imap
anhänge-speichern
id4827
ziel-ordnerR:\\Rechnungen\\Eingang
filter["*.pdf"]
ergebnisgespeicherte_dateien
imap
verschieben
id4827
ziel-ordnerArchiv
- imap:
    server: "imap.firma.de"
    nutzer: "buero@firma.de"
    passwort-cred:
      schlüssel: "IMAP_PASSWORT"
    ordner: "INBOX"
    aktionen:
      - anhänge-speichern:
          id: 4827
          ziel-ordner: "R:\\Rechnungen\\Eingang"
          filter:
            - "*.pdf"
          ergebnis: gespeicherte_dateien
      - verschieben:
          id: 4827
          ziel-ordner: "Archiv"