Notificar mediante correo electrónico la finalización de una tarea es algo que puede simplificar nuestros flujos de trabajo. Por ejemplo, una tarea periódica que se realiza en un servidor nos podría enviar un informe completo con los resultados por lo que solamente tendríamos que revisar este para comprobar que todo es correcto. Una de las formas más sencillas para enviar correos electrónicos desde Python es usar la API de SendGrid, un servicio que ofrece hasta 100 correos gratis y bastante fácil de utilizar. Siendo una alternativa más que interesante al uso de notificaciones o mensajes de WhatsApp.
Tabla de contenidos
Crear una cuenta en SendGrid
Antes de poder enviar un correo electrónico con SendGrid desde Python es necesario crear una cuenta en este servicio. Para ello solo es necesario acceder la página de registro, indicar un usuario, contraseña y aceptar las condiciones de uso. La cuenta gratuita permite enviar hasta 100 correos por día, una cantidad más que suficiente para pruebas.
Doble factor de autenticación
Para acceder al SendGrid es necesario activar un servicio de doble factor de autenticación. Algo que nos indica que el servicio se toma en serio la seguridad de sus usuarios, dificultado de este modo que alguien pueda usar nuestra cuenta para enviar correo no deseado. Para ello tendremos que dar un número de teléfono al que llegará un SMS cada vez que deseamos acceder al servicio o usar un generador de claves de un solo uso basado en nuestro número.
Este punto es importante, ya que sin activar el doble factor de autenticación no podremos usar nuestra cuenta.
Verificar una dirección de envío
Otro punto importante de cara a la seguridad del servicio es la necesidad de verificar la dirección de correo electrónico que se desea usar para recibir las respuestas. El servicio rechazará todos los correos cuyo remitente no haya sido validado previamente en el servicio.
Para crear un nuevo remitente es necesario en nuestra cuenta acceder a la sección Settings y dentro de esta seleccionar Sender Authentication. En esta página podremos ver todos los remitentes validados, por defecto no habrá ninguno, y ofrece la opción de crear un nuevo (Create a Sender). Para la creación de un nuevo remitente se debe pulsar sobre el botón Create a Sender con lo que aparecerá un formulado como el que se muestra a continuación.
En este formulario es necesario incluir todos los campos marcados con punto rojo. Una vez creado el remitente se enviará un correo electrónico para comprobar que tenemos acceso a esa cuenta y poder activarla.
Crear una API key
Una vez tengamos ya un remitente validado en el servicio es necesario crear una API Key para poder enviar correos electrónicos desde Python u otro lenguaje mediante el API. La gestión de las llaves se puede realizar desde la sección API Keys del menú Settings. En esta sección se puede eliminar las claves que ya no se usan, para evitar que alguien pueda usar nuestra cuenta es necesario borrar las claves que ya no se usan o creamos que haya sido comprometidas, y crear nuevas claves. La creación de las claves se realiza pulsando sobre el botón Create API Key, tras lo que aparecerá una ventana como la siguiente.
En esta ventana se debe seleccionar el nombre del API Key, el cual debe ser único para su posterior identificación, y los permisos. Para poder enviar correos la mejor opción es Full Access, aunque es posible limitar los permisos mediante la opción Resticted Access. Una vez seleccionadas las opciones se pulsará sobre Create & View lo que nos mostrará el API Key en una ventana como la siguiente.
Es importante notar que solamente se puede consultar el API Key una vez, por lo que debemos copiar está en un lugar seguro. Si se pierde la clave no existe manera de recuperarla, por lo que será necesario borrarla y crear una nueva.
Instalar SendGrid en Python
Una vez se dispone de API Key ya se puede instalar la librería oficial de SendGrid en Python. Siendo el método más sencillo lanzar el siguiente comando desde la linea de comandos
pip install sendgrid
El único requisito para la instalación es contar con una versión de Python igual o posterior a la 3.5.
Crear correos electrónicos desde Python
Tras la instalación de SendGrid en Python para enviar un correo electrónico básico se puede usar el siguiente código.
import sendgrid
from sendgrid.helpers.mail import Mail, Email, To, Content
sg = sendgrid.SendGridAPIClient(api_key=API_KEY)
from_email = Email("[email protected]")
to_email = To("[email protected]")
subject = "Correo electrónico enviado desde Python"
content = Content("text/plain", "Enviar correos electrónicos desde Python con Sendgrid es sencillo.")
mail = Mail(from_email, to_email, subject, content)
response = sg.send(mail)En este programa, en primer lugar, se importa sendgrid y algunas clases que son necesarias para la creación y envío de correos electrónicos desde Python. Una vez importadas es necesario identificarse en el servicio mediante el API Key, para lo que se usa la función SendGridAPIClient(). Es importante no escribir directamente la API en el código, sino que se debería obtener desde las variables de entorno o un archivo de configuración.
Tras la activación del servicio procederemos a la creación del correo. Para lo que necesitamos el remitente (recordemos que este debe estar validado en el servicio), la dirección de envío, un título para el correo y el contenido. Creando el correo mediante la inyección de estos valores en la clase Mail(). Una vez creado el correo se puede enviar este mediante el método send(). Si todo se ha realizado correctamente el receptor recibirá un correo como el siguiente.
En la variable response se almacena la respuesta del servicio, siendo la propiedad más importante status_code. Cuando el correo se ha enviado correctamente el valor de status_code será 202, en caso contrario habrá algún problema que evitó realizar el envío.
Crear un correo electrónico con adjunto
En los correos existe la posibilidad de incluir adjuntos. Una opción con la que se pueden incluir informes creados en PDF o Word con Python. Para esto es necesario cargar el archivo en base 64 y adjuntarlo a correo usando un código como el siguiente.
import sendgrid
from sendgrid.helpers.mail import Mail, Email, To, Content
sg = sendgrid.SendGridAPIClient(api_key=API_KEY)
from_email = Email("[email protected]")
to_email = To("[email protected]")
subject = "Correo electrónico con adjunto desde Python"
content = Content("text/plain", "Enviar correos electrónicos con adjuntos desde Python con Sendgrid tambien es sencillo.")
mail = Mail(from_email, to_email, subject, content)
with open('report.docx', 'rb') as f:
data = f.read()
f.close()
encoded_file = base64.b64encode(data).decode()
attachedFile = Attachment(
FileContent(encoded_file),
FileName('report.docx'),
FileType('application/vnd.openxmlformats-officedocument.wordprocessingml.document'),
Disposition('attachment')
)
mail.attachment = attachedFile
response = sg.send(mail)En este ejemplo, respecto al código anterior, se ha importado además base64 y las clases para crear adjuntos de sendgrid. Una vez creado el correo, pero antes de enviarlo, se debe importar el archivo y codificarlo en base 64. Con el archivo codificado en una variable se crea un adjunto con la clase Attachment donde además del contenido se debe indicar el nombre, el tipo y las disposición. Adjunto que se agrega a los adjuntos del correo. Al igual que en el ejemplo anterior, una vez creado este se puede enviar correos electrónicos desde Python mediante el método send().
Conclusiones
SendGrid es un servicio que nos permite enviar correos electrónicos desde Python usando un API, lo que simplifica esta tarea. Como ha quedado patente en la entrada no es necesario dar de alta ningún servidor de correo, evitando las tareas de mantenimiento asociadas. Además, para usos básicos, el servicio es gratuito, permitiendo enviar hasta 100 correos al día.
Deja una respuesta