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.
Hace aproximadamente un año, escribí un blog sobre cómo recuperar copias de correos electrónicos para archivarlos y verlos, pero no abordé el almacenamiento real del correo electrónico o 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, aperturas, clics, rebotes, bajas, etc.) en un correo electrónico con el propósito de auditoría, pero opté por 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 aglutine todo esto junto con muestras de código sobre cómo almacenar el cuerpo del correo electrónico y todos sus datos asociados. Durante el próximo año, continuaré construyendo este proyecto con el objetivo de crear una aplicación funcional de almacenamiento y visualización para correos electrónicos archivados y toda la información de registro producida por SparkPost. SparkPost no tiene un sistema que archive el cuerpo del correo electrónico, pero facilita bastante la creación de una plataforma de archivo.
En esta serie de blogs, describiré el proceso que seguí para almacenar el cuerpo del correo electrónico en S3 (Simple Store Service de Amazon) y todos los datos de registro relevantes en MySQL para facilitar el cruce de referencias. Para sistemas de archivo en producción que requieren estrategias robustas de respaldo de bases de datos, considere implementar un proceso integral de respaldo y restauración de PostgreSQL para garantizar que sus datos de archivo estén debidamente protegidos. En última instancia, este es el punto de partida para construir una aplicación que permita una fácil búsqueda de correos electrónicos archivados y luego mostrar esos correos electrónicos junto con los datos de eventos (log). 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 del blog 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 electrónico enviado al destinatario original. Para obtener una copia del cuerpo del correo, necesita:
Capturar el cuerpo del correo antes de enviar el correo
Hacer que el servidor de correo almacene una copia
Hacer que el servidor de correo cree una copia para que usted la almacene
Si el servidor de correo está agregando elementos como seguimiento de enlaces o seguimiento de aperturas, no puede usar el #1 porque no reflejará los cambios de seguimiento de aperturas/clics.
Eso significa que el servidor tiene que almacenar el correo electrónico o de alguna manera ofrecerle una copia de ese correo para almacenamiento. Dado que SparkPost no tiene un mecanismo de almacenamiento para cuerpos de correo pero tiene una forma de crear una copia del correo, haremos que SparkPost nos envíe un duplicado del correo para que lo almacenemos en S3.
Esto se hace utilizando la función de Archivo de SparkPost. La función de Archivo de SparkPost da al remitente la capacidad de decir a SparkPost que envíe un duplicado del correo a una o más direcciones de correo electrónico y utilice 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 con el correo RCPT TO son que algunos de los encabezados serán diferentes ya que la dirección de destino para el correo de archivo es diferente, ¡pero el cuerpo del correo será una réplica exacta!
Si quiere una explicación más profunda aquí hay un enlace a la documentación de SparkPost sobre la creación de copias duplicadas (o archivadas) de un correo electrónico.
Como una nota al margen, SparkPost realmente le permite enviar correos electrónicos a direcciones de cc, bcc y archivo. Para esta solución, nos enfocamos en las direcciones de archivo.
* Aviso * ¡Los correos electrónicos 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 observar los datos de registro que se producen y algunas de las sutilezas dentro de esos datos. SparkPost rastrea todo lo que sucede en sus servidores y ofrece esa información en forma de eventos de mensajería. 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 mensajería, o puede hacer que SparkPost envíe esos eventos a cualquier número de aplicaciones colectoras que desee. El mecanismo de envío se realiza a través de webhooks y se lleva a cabo en tiempo real.
Actualmente, hay 14 eventos diferentes que pueden ocurrir en 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
* Siga 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 de geolocalización.
Una entrada muy importante de eventos de mensajería para este proyecto es el transmission_id. Todas las entradas de eventos de mensajería para el correo original, el correo archivado y cualquier dirección de 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 del correo archivado. Cualquier dirección de cc o bcc tendrá su propio id para la entrada message_id.
Hasta ahora esto suena genial y francamente bastante fácil, pero ahora viene la parte desafiante. Recuerde, para obtener el correo archivado, hacemos que SparkPost envíe un duplicado del correo original a otra dirección de correo electrónico que corresponda a algún buzón al que tenga acceso. Pero para automatizar esta solución y almacenar el cuerpo del correo, voy a usar otra función de SparkPost llamada Inbound Email Relaying. Lo que eso hace es tomar todos los correos enviados a un dominio específico y procesarlos. Al procesarlos, desarma el correo electrónico y crea una estructura JSON que luego se entrega a una aplicación a través de un webhook. Consulte el Apéndice A para ver un ejemplo de JSON.
Si observa detenidamente, notará que la estructura JSON del relay entrante carece de un campo muy importante; el transmission_id. Aunque 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 de entrada está conectado a cualquiera de los correos enviados. El proceso de entrada simplemente sabe que se envió un correo a un dominio específico y debe analizarlo. Eso es todo. Tratará cualquier correo enviado a ese dominio de la misma manera, ya sea una respuesta de un cliente o el correo archivado enviado desde SparkPost.
Entonces, el truco es; ¿cómo conecta los datos salientes con el proceso de entrada que acaba de captar 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 usted, pero simplemente creé un campo de entrada con la etiqueta oculto activada.
También agregué 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 para 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 del blog correspondientes.
Capturar y almacenar el correo archivado junto con una entrada en la base de datos para búsqueda/indexación
Capturar todos los datos de eventos de mensajería
Crear una aplicación para ver el correo electrónico 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 los eventos de mensajería en MySQL. Puede esperar las dos primeras entregas de código y entradas del blog a principios de 2019. Si tiene alguna pregunta o sugerencia, no dude en enviarlas.
Feliz Envío.
– Jeff
Apéndice A:
