FB_Pop3EMailClient

Übersicht

 

 

Aufgabe

Der Funktionsbaustein FB_Pop3EMailClient enthält die zugehörigen Funktionen für das Empfangen und Löschen von E-Mails mithilfe von POP3. Jede Instanz verwaltet eine POP3-Verbindung.

Funktionsbeschreibung

Der Funktionsbaustein FB_Pop3EMailClient fungiert als Benutzerschnittstelle für die Interaktion mit einem externen POP3-E-Mail-Server. Er ermöglicht Ihnen das Empfangen und Löschen von E-Mails. Durch die Verwendung von Anhängen empfangener E-Mails erhalten Sie Informationen zu verschiedenen Systemfunktionen, die auf Dateien im Systemspeicher basieren. Einige Dateierweiterungen dürfen nicht mittels FB_Pop3EMailClient auf dem Steuerungsdatei­system gespeichert werden (siehe Parameter ET_EmailStatus.InvalidAttachmentExtension). Dies betrifft Dateien, die automatisch von der Steuerung verarbeitet werden, sowie Systemdateien, wie die Steuerungsfirmware, damit keine Dateien versehentlich überschrieben werden.

Nach der Aktivierung des Funktionsbausteins und dessen Ausführung wird unter Verwendung der benutzerspezifischen Anmeldedaten, die über iq_stCredentials zugeteilt wurden, eine TCP-Verbindung zum POP3-Server hergestellt. Sobald die Verbindung hergestellt wurde, wird der über i_etCommand angegebene Befehl ausgeführt.

Bei der Ausführung des Funktionsbausteins werden die Zeiger für i_pbyMessage und iq_stCredentilas.i_pbyWhiteListSender  intern zur weiteren Verwendung gespeichert. Wenn während der Ausführung des Funktionsbausteins (q_xBusy = TRUE) eine Online-Änderung erkannt wird, werden die intern verwendeten Variablen mit dem aktuellen Wert der Zeiger aktualisiert.

HINWEIS: Weisen Sie i_pbyMessage und iq_stCredentilas.i_pbyWhiteListSender  keinem anderen Speicherbereich zu, während der Funktionsbaustein ausgeführt wird.

Nach Abschluss der Datenübertragung wird die TCP-Verbindung zum POP3-Server automatisch vom Funktionsbaustein beendet. Empfangene E-Mails werden vom POP3-Server gelöscht.

Der Funktionsbaustein FB_Pop3EMailClient speichert die Informationen der empfangenen E-Mails in dem vom Zeiger i_pbyMailboxBuffer adressierten Speicherbereich. Die Positionen innerhalb des Puffers mit den Informationen der verschiedenen E-Mails werden von den Zeigern in der Struktur iq_astInbox ausgewiesen. Wenn bei aktiviertem Funktionsbaustein FB_Pop3EMailClient eine Online-Änderung erkannt wird, erfasst der Funktionsbaustein eine mögliche Änderung des Zeigers für i_pbyMailboxBuffer, sodass die in der Struktur iq_astInbox bereitgestellten Zeiger entsprechend aktualisiert werden.

HINWEIS: Verarbeiten Sie die Informationen der empfangenen E-Mails, bevor Sie eine Änderung an der Adresse des Zeigers i_pbyMailboxBuffer für die nächste Ausführung vornehmen.

Sie können E-Mails auch manuell löschen, indem Sie die E-Mail mittels ihrer eindeutigen ID am Eingang i_sUniqueId spezifizieren und den Löschbefehl mit i_etCommand ausführen. Wenn weitere Befehle ausgeführt werden, wird die in q_astInbox verfügbare Posteingangsstruktur mit den Referenzen zu den E-Mail-Daten zurückgesetzt.

Empfangene E-Mails werden im flüchtigen Speicher gehalten. Der flüchtige Speicher wird geleert, wenn die Stromzufuhr unterbrochen wird und alle darin gehaltenen E-Mails werden gelöscht.

Während der Ausführung des Funktionsbausteins steht der Ausgang q_xBusy auf TRUE. Der Ausgang q_xDone wird auf TRUE gesetzt, sobald der Funktionsbaustein erfolgreich ausgeführt wurde.

Die Abbildung zeigt das Signalverhalten der Eingänge und Ausgänge des Funktionsbaustein.

 

 

Statusmeldungen und Diagnoseinformationen werden unter Verwendung der Ausgänge q_xError (TRUE, wenn ein Fehler erkannt wurde), q_etResult und q_etResultMsg bereitgestellt.

Um erkannte Fehler zu quittieren, deaktivieren und aktivieren Sie den Funktionsbaustein dann erneut, um eine E-Mail empfangen oder löschen zu können.

Schnittstelle

Verwendung von Variablen des Typs POINTER TO ... oder REFERENCE TO ...

Der Funktionsbaustein POINTER stellt Eingänge und/oder Ein-/Ausgänge vom Typ POINTER TO… oder REFENCE TO… bereit. Mithilfe eines derartigen Zeigers bzw. einer derartigen Referenz greift der Funktionsbaustein auf den adressierten Speicherbereich zu. Bei einer Online-Änderung kann es vorkommen, dass die Speicherbereiche zu neuen Adressen verschoben wurden. Infolgedessen ist ein Zeiger bzw. eine Referenz dadurch ungültig. Um Fehler in Verbindung mit ungültigen Zeigern zu vermeiden, müssen Variablen des Typs POINTER TO… oder REFERENCE TO… zyklisch aktualisiert werden oder zumindest am Anfang des Zyklus, in dem sie verwendet werden.