/ 
Quiq-1.220
River stage zero No dependents
/ Quiq::Imap::Client

NAME

Quiq::Imap::Client - IMAP Client

BASE CLASSES

DESCRIPTION

Ein Objekt der Klasse repräsentiert einen IMAP-Client.

Die Klasse realisiert ihre Funktionalität unter Rückgriff auf Net::IMAP::Simple durch Ableitung. Detaillierte Dokumentation siehe dort.

Die Klasse zeichnet sich gegenüber ihrer Basisklasse dadurch aus, dass

  • sie Fehler nicht über Returnwerte anzeigt, sondern im Fehlerfall eine Exception wirft

  • die Methode get() die Mail als vollständigen Text liefert

Der Mail-Text kann zur Instantiierung eines Objekts zur weiteren Verarbeitung genutzt werden kann (z.B. via Email::Simple, Email::MIME oder MIME::Parser)

METHODS

Konstruktor

new() - Instantiiere Objekt

Synopsis

$imap = $class->new($host,%opt);

Arguments

$host

(String) IMAP-Host, ggf. mit Port

%opt

Optionale Angaben als Schlüssel/Wert-Paare

Returns

Object

Description

Instantiiere eine Objekt der Klasse und liefere eine Referenz auf dieses Objekt zurück.

Example

my $imap = Quiq::Imap::Client->new('imap.example.com');

Objektmethoden

login() - Führe Authentisierung gegenüber Server durch

Synopsis

$imap->login($user,$password);

Arguments

$user

(String) Name des Benutzers

$password

(String) Passwort des Benutzers

Description

Führe eine Authetisierung gegenüber dem Server durch.

Example

$imap->login('kallisto','geheim');

select() - Wähle Verzeichnis

Synopsis

$n = $imap->select($folder);

Arguments

$folder

(String) Name des Verzeichnisses

Returns

(Integer) Anzahl der Mails im Verzeichnis

Description

Wähle Verzeichnis $folder aus und liefere die Anzahl der darin enthaltenen Mails zurück.

Example

$n = $imap->select('INBOX');

search() - Suche Mails

Synopsis

@arr = $imap->search($query);

Arguments

$query

(String) Anfrage-Zeichenkette (Details s. Originaldoku)

Returns

(Array) Liste der Mail-Nummern

Description

Suche alle Mails im ausgewählten Verzeichnis (s. $imap->select()) und liefere die Liste der Mail-Nummern zurück.

Example

@arr = $imap->search('FROM "john@example.com"');

get() - Liefere Mail als Text

Synopsis

$message = $imap->get($i);

Arguments

$i

(Integer) Mail-Nummer innerhalb des Verzeichnisses

Returns

(String) Mail als Zeichenkette

Description

Hole die Mail mit der Nummer $i aus dem gewählten IMAP-Verzeichnis und liefere sie als Zeichnkette zurück.

VERSION

1.220

AUTHOR

Frank Seitz, http://fseitz.de/

COPYRIGHT

Copyright (C) 2024 Frank Seitz

LICENSE

This code is free software; you can redistribute it and/or modify it under the same terms as Perl itself.