Con el aumento del uso del correo electrónico en entornos regulatorios, he decidido que es momento de iniciar un nuevo proyecto que reúna todo esto con ejemplos de código sobre cómo almacenar el cuerpo del correo electrónico y todos sus datos asociados.
Business in a box.
Descubre nuestras soluciones.
Habla con nuestro equipo de ventas
Hace aproximadamente un año escribí un blog sobre cómo recuperar copias de correos electrónicos para archivado y visualización, pero no abordé el almacenamiento real del correo o los datos relacionados, y recientemente escribí un blog sobre el almacenamiento de todos los datos de eventos (es decir, cuando se envió el correo electrónico, se abrió, se hicieron clics, rebotó, se desuscribió, etc.) en un correo electrónico con el propósito de auditoría, pero elegí no crear ningún código de soporte.
Con el aumento del uso del correo electrónico en entornos regulatorios, he decidido que es hora de comenzar un nuevo proyecto que reúna todo esto con ejemplos de código sobre cómo almacenar el cuerpo del correo y todos sus datos asociados. Durante el próximo año, continuaré construyendo sobre este proyecto con el objetivo de crear una aplicación funcional de almacenamiento y visualización para correos archivados e información de registro producida por SparkPost. SparkPost no tiene un sistema que archive el cuerpo del correo, pero facilita bastante la construcción de una plataforma de archivo.
En esta serie de blogs, describiré el proceso que seguí para almacenar el cuerpo del correo en S3 (Servicio de Almacenamiento Simple de Amazon) y todos los datos de registro relevantes en MySQL para una fácil referencia cruzada. En última instancia, este es el punto de partida para construir una aplicación que permitirá la búsqueda fácil de correos archivados, y luego mostrará esos correos junto con los datos de eventos (registro). El código para este proyecto se puede encontrar en el siguiente repositorio de GitHub: https://github.com/jeff-goldstein/PHPArchivePlatform
Esta primera entrada de la serie de blogs va a describir el desafío y establecer una arquitectura para la solución. El resto de los blogs detallarán partes de la solución junto con ejemplos de código.
El primer paso en mi proceso fue averiguar cómo iba a obtener una copia del correo enviado al destinatario original. Para obtener una copia del cuerpo del correo, necesitas hacer una de las siguientes:
Capturar el cuerpo del correo antes de enviar el correo
Conseguir que el servidor de correo almacene una copia
Hacer que el servidor de correo cree una copia para que la almacenes
Si el servidor de correo está agregando elementos como el seguimiento de enlaces o el seguimiento de aperturas, no puedes usar el #1 porque no reflejará los cambios de seguimiento de apertura/clics.
Eso significa que, o bien el servidor tiene que almacenar el correo, o de alguna manera ofrecerte una copia de ese correo para almacenamiento. Dado que SparkPost no tiene un mecanismo de almacenamiento para cuerpos de correo pero sí tiene una forma de crear una copia del correo, haremos que SparkPost nos envíe un duplicado del correo para que lo almacenes en S3.
Esto se hace utilizando la función de Archivo de SparkPost. La función de Archivo de SparkPost le da al remitente la capacidad de decirle a SparkPost que envíe un duplicado del correo a una o más direcciones de correo y use los mismos enlaces de seguimiento y apertura que el original. La documentación de SparkPost define su función de Archivo de la siguiente manera:
Los destinatarios en la lista de archivo recibirán una réplica exacta del mensaje que se envió a la dirección RCPT TO. En particular, cualquier enlace codificado destinado al destinatario RCPT TO será idéntico en los mensajes de archivo.
Las únicas diferencias respecto al correo RCPT TO son que algunos de los encabezados serán diferentes ya que la dirección objetivo para el correo de archivo es diferente, ¡pero el cuerpo del correo será una réplica exacta!
Si quieres una explicación más profunda, aquí hay un enlace a la documentación de SparkPost sobre cómo crear copias duplicadas (o de archivo) de un correo.
Como nota al margen, SparkPost de hecho permite enviar correos a direcciones de cc, bcc y archivo. Para esta solución, nos centramos en las direcciones de archivo.
* Aviso * Los correos archivados SOLO se pueden crear al inyectar correos en SparkPost a través de SMTP!
Ahora que sabemos cómo obtener una copia del correo original, necesitamos ver los datos de registro que se producen y algunas de las sutilezas dentro de esos datos. SparkPost rastrea todo lo que ocurre en sus servidores y te ofrece esa información en forma de eventos de mensaje. Esos eventos se almacenan en SparkPost durante 10 días y se pueden extraer del servidor a través de una API RESTful llamada eventos de mensaje, o puedes hacer que SparkPost envíe esos eventos a cualquier cantidad de aplicaciones de recopilación que desees. El mecanismo de envío se hace a través de webhooks y se realiza en tiempo real.
Actualmente, hay 14 eventos diferentes que pueden ocurrir a un correo. Aquí hay una lista de los eventos actuales:
Bounce
ClickDelay
Delivery
Generation Failure
Generation Rejection
Initial Open
InjectionLink Unsubscribe
List Unsubscribe
Open
Out of Band
Policy RejectionSpam Complaint
* Sigue este enlace para una guía de referencia actualizada para una descripción de cada evento junto con los datos que se comparten para cada evento.
Cada evento tiene numerosos campos que coinciden con el tipo de evento. Algunos campos como el transmission_id se encuentran en cada evento, pero otros campos pueden ser más específicos del evento; por ejemplo, solo los eventos de apertura y clic tienen información geotag.
Una entrada de evento de mensaje muy importante para este proyecto es el transmission_id. Todas las entradas de eventos de mensaje para el correo original, el correo archivado y cualquier dirección cc y bcc compartirán el mismo transmission_id.
También hay una entrada común llamada message_id que tendrá el mismo id para cada entrada del correo original y el correo archivado. Cualquier dirección cc o bcc tendrá su propio id para la entrada de message_id.
Hasta ahora, esto suena genial y francamente bastante fácil, pero ahora viene la parte desafiante. Recuerda, para obtener el correo de archivo, hacemos que SparkPost envíe un duplicado del correo original a otra dirección de correo que corresponde a una bandeja de entrada a la que tienes acceso. Pero para automatizar esta solución y almacenar el cuerpo del correo, voy a usar otra función de SparkPost llamada Reenvío de Correo Entrante. Lo que hace es tomar todos los correos enviados a un dominio específico y procesarlos. Al procesarlos, descompone el correo y crea una estructura JSON que luego se entrega a una aplicación a través de un webhook. Consulta el Apéndice A para ver un ejemplo de JSON.
Si miras detenidamente, notarás que la estructura JSON del reenviador entrante falta un campo muy importante; el transmission_id. Mientras que todos los correos salientes tienen el transmission_id con la misma entrada que vincula todos los datos del correo original, archivo, cc y bcc; SparkPost no tiene forma de saber que el correo capturado por el proceso entrante está conectado a cualquiera de los correos salientes. El proceso entrante simplemente sabe que se envió un correo a un dominio específico y debe analizar el correo. Eso es todo. Tratará cualquier correo enviado a ese dominio de la misma manera, ya sea una respuesta de un cliente o el correo de archivo enviado desde SparkPost.
Así que el truco es; ¿cómo vinculas los datos salientes al proceso entrante que acaba de tomar la versión archivada del correo? Lo que decidí hacer es ocultar un id único en el cuerpo del correo. Cómo se hace esto depende de ti, pero simplemente creé un campo de entrada con la etiqueta oculta activada.
También añadí ese campo en el bloque de metadatos del encabezado X-MSYS-API que se pasa a SparkPost durante la inyección. Este UID oculto terminará siendo el pegamento de todo el proceso, y es un componente principal del proyecto y se discutirá en profundidad en las siguientes publicaciones del blog.
Ahora que tenemos el UID que unirá este proyecto y entendemos por qué es necesario, puedo comenzar a construir la visión del proyecto general y las publicaciones de blog correspondientes.
Capturar y almacenar el correo archivado junto con una entrada de base de datos para búsqueda/indexación
Capturar todos los datos de eventos de mensajes
Crear una aplicación para ver el correo y todos los datos correspondientes
Aquí hay un diagrama simple del proyecto:
La primera entrega de código cubrirá el proceso de archivo y el almacenamiento del correo en S3, mientras que la segunda entrega de código cubrirá el almacenamiento de todos los datos de registro de eventos de mensajes en MySQL. Puedes esperar las dos primeras entregas de código y entradas de blog a principios de 2019. Si tienes alguna pregunta o sugerencia, no dudes en compartirla.
Feliz envío.
– Jeff
Apéndice A:
