sendgrid python

Esta biblioteca le permite utilizar rápida y fácilmente la API web SendGrid v3 a través de Python.

La versión 3.X.X+ de esta biblioteca proporciona soporte completo para todos los puntos finales de SendGrid Web API v3, incluido el nuevo v3 /mail/send.

Esta biblioteca representa el comienzo de un nuevo camino para SendGrid. Queremos que esta biblioteca sea impulsada por la comunidad y dirigida por SendGrid. Necesitamos su ayuda para lograr este objetivo. Para ayudar a asegurarnos de que estamos creando las cosas correctas en el orden correcto, le pedimos que cree problemas y solicitudes de extracción o simplemente vote o comente sobre problemas o solicitudes de extracción existentes.

Si necesita ayuda para usar SendGrid, consulte el Centro de ayuda de soporte de Twilio SendGrid.

Lea el resto de este archivo README para obtener más detalles.

Tabla de contenido

• Instalación
• Inicio rápido
• Procesamiento de correo electrónico entrante
• Uso
• Casos de uso
• Anuncios
• Cómo contribuir
• Solución de problemas
• Acerca de
• Apoyo
• Licencia

Instalación

Requisitos previos

• Versión de Python 2.7+
• El servicio SendGrid, empezando por el nivel gratuito

Configurar variables de entorno

Impermeable

Actualiza el entorno de desarrollo con tu SENDGRID_API_KEY (más información aquí), por ejemplo:

 echo " export SENDGRID_API_KEY='YOUR_API_KEY' " > sendgrid.env
echo " sendgrid.env " >> .gitignore
source ./sendgrid.env

SendGrid también admite el archivo de entorno local .env . Copie o cambie el nombre .env_sample a .env y actualice SENDGRID_API_KEY con su clave.

ventanas

Establezca temporalmente la variable de entorno (accesible solo durante la sesión cli actual):

 set SENDGRID_API_KEY=YOUR_API_KEY

Establezca permanentemente la variable de entorno (accesible en todas las sesiones cli posteriores):

setx SENDGRID_API_KEY " YOUR_API_KEY " 

Instalar paquete

pip install sendgrid

Dependencias

• Cliente Python-HTTP
• ECDSA-Python

Inicio rápido

Hola correo electrónico

El siguiente es el código mínimo necesario para enviar un correo electrónico con el asistente /mail/send (aquí hay un ejemplo completo):

Con clase de ayuda de correo

 import sendgrid
import os
from sendgrid . helpers . mail import *

sg = sendgrid . SendGridAPIClient ( api_key = os . environ . get ( 'SENDGRID_API_KEY' ))
from_email = Email ( "[email protected]" )
to_email = To ( "[email protected]" )
subject = "Sending with SendGrid is Fun"
content = Content ( "text/plain" , "and easy to do anywhere, even with Python" )
mail = Mail ( from_email , to_email , subject , content )
response = sg . client . mail . send . post ( request_body = mail . get ())
print ( response . status_code )
print ( response . body )
print ( response . headers )

El constructor Mail crea un objeto de personalización para usted. A continuación se muestra un ejemplo de cómo agregarlo.

Sin clase de ayuda de correo

El siguiente es el código mínimo necesario para enviar un correo electrónico sin el asistente /mail/send (aquí hay un ejemplo completo):

 import sendgrid
import os

sg = sendgrid . SendGridAPIClient ( api_key = os . environ . get ( 'SENDGRID_API_KEY' ))
data = {
  "personalizations" : [
    {
      "to" : [
        {
          "email" : "[email protected]"
        }
      ],
      "subject" : "Sending with SendGrid is Fun"
    }
  ],
  "from" : {
    "email" : "[email protected]"
  },
  "content" : [
    {
      "type" : "text/plain" ,
      "value" : "and easy to do anywhere, even with Python"
    }
  ]
}
response = sg . client . mail . send . post ( request_body = data )
print ( response . status_code )
print ( response . body )
print ( response . headers )

Uso general de la API web v3 (con interfaz fluida)

 import sendgrid
import os

sg = sendgrid . SendGridAPIClient ( api_key = os . environ . get ( 'SENDGRID_API_KEY' ))
response = sg . client . suppression . bounces . get ()
print ( response . status_code )
print ( response . body )
print ( response . headers )

Uso general de la API web v3 (sin interfaz fluida)

 import sendgrid
import os

sg = sendgrid . SendGridAPIClient ( api_key = os . environ . get ( 'SENDGRID_API_KEY' ))
response = sg . client . _ ( "suppression/bounces" ). get ()
print ( response . status_code )
print ( response . body )
print ( response . headers )

Procesamiento de correo electrónico entrante

Consulte a nuestro ayudante para utilizar nuestro webhook Inbound Parse.

Uso

• Documentación de SendGrid
• Documentación de uso de la biblioteca
• Código de ejemplo
• Cómo hacerlo: Migración de v2 a v3
• Asistente de envío de correo de API web v3: cree una carga útil de objeto de solicitud para una llamada de API /mail/send v3.
• Procesamiento de correo electrónico entrante

Casos de uso

Ejemplos de casos de uso de API comunes, como cómo enviar un correo electrónico con una plantilla transaccional.

Anuncios

Todas las actualizaciones de esta biblioteca están documentadas en nuestro CHANGELOG y lanzamientos.

Cómo contribuir

Alentamos la contribución a nuestras bibliotecas (incluso podrías conseguir algún regalo ingenioso); consulta nuestra guía CONTRIBUCIÓN para obtener más detalles.

Enlaces rápidos:

• Solicitud de función
• Informes de errores
• Mejoras en el código base
• Revisar solicitudes de extracción

Solución de problemas

Consulte nuestra guía de solución de problemas para conocer problemas comunes de la biblioteca.

Acerca de

sendgrid-python es mantenido y financiado por Twilio SendGrid, Inc. Los nombres y logotipos de sendgrid-python son marcas comerciales de Twilio SendGrid, Inc.

Apoyo

Si necesita soporte, consulte el Centro de ayuda de soporte de Twilio SendGrid.

Licencia

La licencia MIT (MIT)