Mailserver

Klassendiagramm

Flussdiagramm

Konfigurations-Parameter

TBD

Schnittstellen

Modul server.py

class einsatzserver.mailserver.mailserver.Mailserver(servercredentials)

Klasse Mailserver

Die Klasse Mailserver kann genutzt werden um eine Verbindung zu einem Email Server aufzubauen. Anschließend können Emails vom Server abgerufen werden.

Attributes:

__servercredentials (object): Objekt der Klasse Servercredentials
__num_of_mails (integer): Anzahl der Emails im Postfach
__imap (object): imap Objekt

Args:

servercredentials (objekt): Objekt der Klasse Servercredentials

erzeuge_imap_objekt(): Methode erzeuge_imap_objekt Die Methode erzeuge_imap_objekt instanziert eine Objekt der Klasse IMAP4_SSL

open_connection()

Methode open_connection

Die Mehtode open_connection versucht eine Verbindung zum Mailserver aufzubauen. Anschließend wird die INBOX geöffnet.

Returns:

bool: Postfach erfolgreich geöffnet? True/False
int: Anzahl Mails im Postfach

get_mail(move_to_archiv=True)

Methode get_mail

Die Methode get_mail gibt für jede Email im Posteingang ein Objekt der Klasse Email zurück.

Args:

move_to_archiv (bool): Emails in Archiv verschieben?

Returns:

int: Anzahl der Mailobjekte die übergeben werden.
object array: Emails vom Mailserver, als Instanzen der Klasse Email.

close_connection()

Methode close_connection

Die Methode close_connection() schließt das Postfach und trennt die Verbindung zum Server.

Returns:: True wenn Vebrindunge erfolgreich geschlossen werden konnte, ansonsten False

check_for_mail()

Methode check_for_mail

Die Methode check_for_mail gibt eine Liste der gefundenen Mail IDs im aktuell geöffneten Ordner auf dem IMAP4 Server zurück.

Returns:

bool: Methode erfolgreich: True ansosnten False
list: data –> Liste der Mail IDs