Hace aproximadamente un año escribí un blog sobre cómo recuperar copias de correos electrónicos para archivo y visualización, pero no abordé el almacenamiento real del correo electrónico o datos relacionados, y recientemente escribí un blog sobre cómo almacenar todos los datos de eventos (es decir, cuándo se envió el correo electrónico, aperturas, clics, rebotes, cancelaciones de suscripción, etc.) de un correo electrónico con el objetivo 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 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. A lo largo del próximo año, continuaré desarrollando 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 hace que la construcción de una plataforma de archivo sea bastante fácil.
En esta serie de blogs, describiré el proceso que seguí para almacenar el cuerpo del correo electrónico 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 electrónicos 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 delinear una arquitectura para la solución. Los demás 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 electrónico, necesitas hacer uno de los siguientes:
Capturar el cuerpo del correo electrónico 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 tú la almacenes
Si el servidor de correo está agregando elementos como seguimiento de enlaces o seguimiento de aperturas, no puedes usar la opción #1 porque no reflejará los cambios de seguimiento de aperturas/clics.
Eso significa que o bien el servidor tiene que almacenar el correo electrónico o de alguna manera ofrecerte una copia de ese correo para almacenamiento. Dado que SparkPost no tiene un mecanismo de almacenamiento para cuerpos de correos electrónicos pero sí 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 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 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 del correo electrónico RCPT TO son que algunos de los encabezados serán diferentes, ya que la dirección de destino para el correo electrónico de archivo es diferente, pero el cuerpo del correo electrónico será una réplica exacta!
Si quieres una explicación más profunda, aquí hay un enlace a la documentación de SparkPost sobre la creación de copias duplicadas (o de archivo) de un correo electrónico.
Como nota al margen, SparkPost en realidad te permite enviar correos electrónicos a direcciones de correo electrónico cc, bcc y de archivo. Para esta solución, estamos enfocados en las direcciones de archivo.
* Aviso * Los correos electrónicos archivados SOLO pueden ser creados al inyectar correos electrónicos en SparkPost a través de SMTP!
Ahora que sabemos cómo obtener una copia del correo electrónico original, necesitamos ver los datos de registro que se producen y algunas de las sutiles diferencias dentro de esos datos. SparkPost rastrea todo lo que sucede 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 pueden ser recuperados del servidor a través de una API RESTful llamada eventos de mensaje, o puedes hacer que SparkPost envíe esos eventos a cualquier número de aplicaciones recolectoras que desees. El mecanismo de envío se realiza a través de webhooks y se hace en tiempo real.
Actualmente, hay 14 eventos diferentes que pueden sucederle a un correo electrónico. Aquí hay una lista de los eventos actuales:
Rebote
Retraso de Clic
Entrega
Fallo de Generación
Rechazo de Generación
Apertura Inicial
Unsubscribe de Enlace de Inyección
Unsubscribe de Lista
Apertura
Fuera de Banda
Rechazo de Política - Queja de Spam
* 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 de geolocalización.
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 electrónico original, el correo electrónico 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 electrónico original y el correo electrónico archivado. Cualquier dirección de 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 electrónico archivado, hacemos que SparkPost envíe un duplicado del correo electrónico original a otra dirección de correo electrónico que corresponde a algún correo que tú tengas acceso. Pero para automatizar esta solución y almacenar el cuerpo del correo electrónico, voy a usar otra función de SparkPost llamada Redirección de Correo Entrante. Lo que eso hace es tomar todos los correos enviados a un dominio específico y procesarlos. Al procesarlos, descompone el correo electrónico 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 un ejemplo de JSON.
Si miras con atención, notarás que la estructura JSON del redireccionador entrante carece de un campo muy importante; el transmission_id. Aunque todos los correos electrónicos salientes tienen el transmission_id con la misma entrada que une todos los datos del correo electrónico original, archivo, direcciones cc y bcc; SparkPost no tiene forma de saber que el correo electrónico 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 que 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 archivado enviado por SparkPost.
Así que el truco es; ¿cómo puedes unir los datos salientes con el proceso entrante que acaba de capturar la versión archivada del correo electrónico? Lo que decidí hacer es ocultar un id único en el cuerpo del correo. Cómo se hace esto depende de ti, pero yo simplemente creé un campo de entrada con la etiqueta hidden activada.
<input name="ArchiveCode" type="hidden" value="<<UID>>">
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 para todo el proceso, y es un componente principal del proyecto que se discutirá en profundidad en las próximas 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 entradas correspondientes del blog.
Capturar y almacenar el correo electrónico archivado junto con una entrada de base de datos para búsqueda/indexación
Capturar todos los datos de eventos de mensaje
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 almacenamiento del correo electrónico en S3, mientras que la segunda entrega de código cubrirá el almacenamiento de todos los datos de registro de eventos de mensaje en MySQL. Puedes esperar las primeras dos entregas de código y entradas de blog en algún momento a principios de 2019. Si tienes alguna pregunta o sugerencia, no dudes en hacérmelas saber.
Feliz envío.
– Jeff
Apéndice A:
