Anhang A - Weitere Bibliotheken. Die Bibliothek Mail_02.lib ermöglicht das Versenden von s mit dem Ethernet-Controller

Transkript

1 Anhang A - Weitere Bibliotheken WAGO-I/O-PRO 32 Bibliothek Mail_02.lib Die Bibliothek Mail_02.lib ermöglicht das Versenden von s mit dem Ethernet-Controller Inhalt Mail_02.lib 3 MAIL_SmtpClient... 3 MAIL_Pop3Client... 5 MAIL_SenderArray... 7 MAIL_ReadEthernetAnswer... 8 MAIL_Base64Code... 9 MAIL_IpAdress MAIL_MemCopy MAIL_typMail (Datentyp) WAGO-I/O-PRO 32 Version Mail_02.lib - 1

2 MAIL_SmtpClient 2 Mail_02.lib ml00900d WAGO-I/O-PRO 32

3 Anhang A - Weitere Bibliotheken Mail_02.lib MAIL_SmtpClient MAIL_SmtpClient Typ: Funktion Funktionsblock X Programm Verwendete Bibliotheken Ethernet.lib ssmtpserverip STRING IP-Addresse des SMTP-Servers sfrom STRING -Adresse des Absenders sto STRING -Adresse des Empfängers ssubject STRING Betreffzeile der Nachricht smessage STRING(255) Nachrichtentext sattachmentfilename STRING(255) Dateiname der Anlage ptattachment Pointer to Array[ ] of Byte Datenbereich der in die Anlage kopiert werden soll iattachmentlength INT Länge der Anlage in Byte (max Byte) xsend BOOL Bei einer steigenden Flanke an diesem Eingang wird die Nachricht gesendet. Nach der Ausführung wird das Signal automatisch zurückgesetzt. xdone BOOL werror WORD 0: no error 17: attachment data to long 33, 65, 97, 129, 257, 305, 337: failure during smtp protocol 254: internal error, check your application program 255: ethernet connection to the mail server not available sanswer STRING WAGO-I/O-PRO 32 Version Mail_02.lib - 3

4 MAIL_SmtpClient Dieser Funktionsblock verwendet das SMTP-Protocol zum versenden von s an einen Mail-Server. Der Mail-Server muss das MIME V1.0 Format unterstützen. Die s können über eine BASE64 -codierte Anlage verfügen. dies erlaubt das Versenden von Binärdaten in der Anlage. Um eine ohne Anlage zu versenden sind die Eingänge sattachmentfilename, ptattachment and iattachmentlength nicht zu beschalten. Gestartet wird die Übertragung der mit der steigenden Flanke am Eingang xstart. Nach der Übertragung wird der Eingang xstart zurückgesetzt und an den das Ergebnis der Übertragung ablesen. 4 Mail_02.lib ml00900d WAGO-I/O-PRO 32

5 Anhang A - Weitere Bibliotheken MAIL_Pop3Client MAIL_Pop3Client Typ: Funktion Funktionsblock X Programm Verwendete Bibliotheken Ethernet.lib sip STRING IP-Adresse des POP3-Servers suser STRING Username für Mail-account spass STRING Password für Mail-account xstart BOOL Mit der steigenden Flanke wird eine Verbindung mit dem POP3-Server hergestellt. xclose_pop _CONNECTION BOOL Mit der steigenden Flanke wird eine bestehende Verbindung zu einem POP3-Server beendet. xauthorization_ok BOOL User authorized and connection established xdone BOOL werror WORD 0: no error 1: ethernet connection to the pop3 server not available 65: wrong user name 97: wrong user or password 129: wrong password sanswer STRING WAGO-I/O-PRO 32 Version Mail_02.lib - 5

6 MAIL_Pop3Client Das SMTP-Protokoll besitzt keine Elemente zur Authentifizierung, d. h. SMTP kennt kein user und password und damit keine Möglichkeit nur bestimmten Personen das versenden von s zu gestatten. Verschiedene Mail-Provider setzen das POP3-Protokoll zur Authentifizierung ein. Dieses Verfahren wird auch POP3 before SMTP genannt. Um eine per SMTP zu versenden muss zunächst mit dem POP3-Protocol der Username und Password eines gültigen Mail-Account übergeben werden. Nach erfolgreicher Verbindung/ Prüfung erlaubt der POP3-Server diesem Mail- Account für einen Zeitraum von ca. 5 Minuten die Ausführung des SMTP-Protokolles.. 6 Mail_02.lib ml00900d WAGO-I/O-PRO 32

7 Anhang A - Weitere Bibliotheken MAIL_SenderArray MAIL_SenderArray Typ: Funktion Funktionsblock X Programm Verwendete Bibliotheken Ethernet.lib IP STRING IP Addresse des SMTP-Servers MAIL_FROM STRING(255) Absenderadresse RCPT_TO STRING(255) Ziel-Adresse MAIL MAIL_typMail komplette START BOOL Aktiviert die Übertragung mit der steigenden Flanke. mail_done BOOL Auftrag ausgeführt error_code WORD sanswer STRING Rückmeldung des SMTP-Servers Privater Funktionsbaustein, wird vom SMTP-Client verwendet (Function: Mail sending using SMTP protocoll including an attachment Description:Sending a message with up to 1480 Bytes from an ethernet controller Attachment data will be generatet from an array of Byte. Attachment data will coded according to base64 rules. The format of the message is in accordance to the Mime V1.0 specification. These means, that the mail server receiving this mail, must be able to understand Mime protocol to decode the data. The message will be send with the rising edge of the start input.) WAGO-I/O-PRO 32 Version Mail_02.lib - 7

8 MAIL_ReadEthernetAnswer MAIL_ReadEthernetAnswer MAIL_ReadEthernetAnswer Typ: Funktion X Funktionsblock Programm Verwendete Bibliotheken Ethernet.lib ptnumberoftries POINTER Anzahl von Versuchen TO DWORD Socket WORD Sockethandle ptbuffer POINTER TO ARRAY[ ] OF BYTE Speicherbereich MAIL_ ReadEthernetAnswer INT 0: Antwort erhalten 1: Auf Antwort warten 2: Fehlerhafte oder keine Antwort erhalten Privater Funktionsbaustein, wird vom SMTP-Client verwendet (This function is waiting for the data from the mail server and will return a 0: received an answer from the mail server 1:still waiting for an response from the mail server 2: error or no answer received from the mail server.) 8 Mail_02.lib ml00900d WAGO-I/O-PRO 32

9 Anhang A - Weitere Bibliotheken MAIL_Base64Code MAIL_Base64Code Typ: Funktion X Funktionsblock Programm Verwendete Bibliotheken psourceaddress POINTER TO Rohdaten ARRAY[ ] OF BYTE pdestinationaddress POINTER TO Konvertierte Daten ARRAY[ ] OF BYTE BytesToCode INT Anzahl zu kodierender Bytes MAIL_Base64Code INT Privater Funktionsbaustein, wird vom SMTP-Client verwendet (Function:This function codes data according to base64 rules. Description:The function will return the number of byte in the destination array. This function codes BytesToCode Bytes from the source array of Byte and stores the coded data in the destination array of Bytes. Base64 will calculate for 4 Bytes in the destination array for each 3 Bytes in the source array. Due to this rule the number of BytesToCode is limited to This will ensure that the destination array size of 1500 Bytes will not be exceeded.) WAGO-I/O-PRO 32 Version Mail_02.lib - 9

10 MAIL_IpAdress MAIL_IpAdress MAIL_IpAdress Typ: Funktion X Funktionsblock Programm Verwendete Bibliotheken IP_ADR STRING MAIL_IpAdress DWORD Privater Funktionsbaustein, wird vom SMTP-Client und POP3-Client verwendet (This function convert an IP-Address from a given String to DWORD.) 10 Mail_02.lib ml00900d WAGO-I/O-PRO 32

11 Anhang A - Weitere Bibliotheken MAIL_MemCopy MAIL_MemCopy Typ: Funktion X Funktionsblock Programm Verwendete Bibliotheken psourceaddress POINTER TO Adresse der zu kopierenden Daten ARRAY[1..2] OF BYTE pdestinationaddress POINTER TO ARRAY[1..2] Adresse an die die Daten kopiert werden sollen OF BYTE BytesToCopy WORD Anzahl der zu kopierenden Daten in Bytes MAIL_MemCopy BOOL Ergebnis: True / False Privater Funktionsbaustein, wird vom SMTP-Client verwendet (This function copies BytesToCopy bytes from the source address psourceaddress to the destination address pdestinationaddress.) WAGO-I/O-PRO 32 Version Mail_02.lib - 11

12 MAIL_typMail (Datentyp) MAIL_typMail (Datentyp) MAIL_typMail Typ: Datentyp X Enumeration Struktur: Element: Datentyp: Beschreibung: sfrom STRING(255) Absender sto STRING(255) Empfänger ssubject STRING(255) Betreffzeile smessage STRING(255) Nachrichtentext sattachname STRING(255) Name der Anlage ptattachment POINTER TO Zeiger auf Daten der Anlage ARRAY [ ] OF BYTE iattachlength INT Länge der Anlage Deklaration: TYPE MAIL_typMail : STRUCT sfrom sto ssubject smessage sattachname ptattachment iattachlength END_STRUCT END_TYPE : STRING(255); : STRING(255); : STRING(255); : STRING(255); : STRING(255); : POINTER TO ARRAY[ ] OF BYTE; : INT; Beschreibung: 12 Mail_02.lib ml00900d WAGO-I/O-PRO 32