FB_Pop3EMailClient

Descripción general

 

 

Tarea

El bloque de funciones FB_Pop3EMailClient incluye las funciones relacionadas para recibir y eliminar mensajes de correo electrónico utilizando POP3. Cada instancia gestiona una conexión POP3.

Descripción funcional

El bloque de funciones FB_Pop3EMailClient es la interfaz de usuario para interactuar con un servidor POP3 (de correo electrónico) externo. Permite recibir y eliminar mensajes de correo electrónico. Mediante los adjuntos de los mensajes de correo electrónico recibidos puede obtener información de diversas características del sistema según archivos ubicados en la memoria del sistema. Determinadas extensiones de archivo no se pueden guardar en el sistema de archivos del controlador mediante FB_Pop3EMailClient (consulte el parámetro  ET_Email­Status.InvalidAttachmentExtension). Esto se aplica a los archivos gestionados automáticamente por el controlador y a archivos del sistema, como el firmware del controlador, para ayudar a evitar que se sobrescriban por error.

Después de habilitar y ejecutar el bloque de funciones, se establece una conexión TCP con el servidor POP3 mediante las credenciales de usuario enviadas a través de iq_stCredentials. En cuanto se establece la conexión, se ejecuta el comando especificado con i_etCommand.

Al ejecutar el bloque de funciones, los punteros en i_pbyMessage y iq_stCre­dentilas.i_pbyWhiteListSender  se almacenan internamente para poder utilizarlos en el futuro. En el caso de que se detecte un evento de cambio online mientras se ejecuta el bloque de funciones (q_xBusy = TRUE), las variables de uso interno se actualizarán con el valor actual de los punteros.

NOTA: No reasigne i_pbyMessage ni iq_stCredentilas.i_pbyWhiteListSender  a un área de memoria distinta mientras se ejecute el bloque de funciones.

Cuando haya finalizado la transferencia de datos, el bloque de funciones cerrará la conexión TCP al servidor POP3. Los mensajes de correo electrónico se eliminan del servidor POP3.

El bloque de funciones FB_Pop3EMailClient guarda la información de los mensajes de correo electrónico recibidos en el área de memoria dirigida por el puntero i_pbyMailboxBuffer. Las posiciones del interior del búfer, que contienen la información respectiva de los diferentes mensajes de correo electrónico, se indican mediante los punteros dentro de la estructura iq_astInbox. En el caso de que el bloque de funciones FB_Pop3EMailClient esté habilitado y se detecte un evento de cambio online, el bloque de funciones reconocerá un posible cambio del puntero en i_pbyMailboxBuffer, por lo que los punteros proporcionados en la estructura iq_astInbox se actualizarán correspondientemente.

NOTA: Procese la información de los mensajes de correo electrónico recibidos antes de modificar la dirección del puntero i_pbyMailboxBuffer para la siguiente ejecución.

Es posible eliminar mensajes manualmente especificando el correo electrónico con el ID exclusivo en la entrada i_sUniqueId y ejecutando el comando de borrado con i_etCommand. Al ejecutar comandos adicionales, se restablece la estructura de la bandeja de entrada disponible en q_astInbox que contiene las referencias a los datos de correo electrónico.

Los mensajes de correo electrónico recibidos se almacenan en la memoria volátil. La memoria volátil se borra cuando se desconecta la alimentación y, por lo tanto, todos los mensajes de correo electrónico almacenados allí se eliminan.

Mientras el bloque de funciones se esté ejecutando, la salida q_xBusy se establece como TRUE. La salida q_xDone se establece como TRUE después de que el bloque funciones se haya ejecutado correctamente.

El diagrama muestra el comportamiento de la señal de las entradas y salidas del bloque de funciones:

 

 

Los mensajes de estado y la información de diagnóstico se proporcionan usando las salidas q_xError (TRUE si se ha detectado un error), q_etResult y q_etResultMsg.

Para confirmar los errores detectados, deshabilite y vuelva a habilitar el bloque de funciones para poder recibir o eliminar un mensaje de correo electrónico.

Interfaz

Uso de las variables de tipo POINTER TO ... o REFERENCE TO ...

Este bloque de funciones proporciona entradas o entradas y salidas de tipo POINTER TO… o REFENCE TO…. Al utilizar un puntero o una referencia de este tipo, el bloque de funciones accede al área de memoria dirigida. En el caso de un evento de cambio online, es posible que las áreas de memoria se desplacen hacia nuevas direcciones y que, en consecuencia, un puntero o una referencia pasen a ser no válidos. Para evitar la presencia de errores relacionados con punteros no válidos, las variables de tipo POINTER TO… o REFERENCE TO… deberán actualizarse de manera cíclica o, al menos, al principio del ciclo en el que se utilicen.