sendgrid python

Cette bibliothèque vous permet d'utiliser rapidement et facilement l'API Web SendGrid v3 via Python.

La version 3.X.X+ de cette bibliothèque fournit une prise en charge complète de tous les points de terminaison de l'API Web SendGrid v3, y compris la nouvelle v3 /mail/send.

Cette bibliothèque représente le début d'un nouveau chemin pour SendGrid. Nous voulons que cette bibliothèque soit pilotée par la communauté et dirigée par SendGrid. Nous avons besoin de votre aide pour atteindre cet objectif. Pour nous assurer que nous construisons les bonnes choses dans le bon ordre, nous vous demandons de créer des problèmes et des demandes d'extraction ou simplement de voter pour ou de commenter les problèmes ou les demandes d'extraction existants.

Si vous avez besoin d'aide pour utiliser SendGrid, veuillez consulter le centre d'aide du support Twilio SendGrid.

Veuillez parcourir le reste de ce README pour plus de détails.

Table des matières

• Installation
• Démarrage rapide
• Traitement des e-mails entrants
• Usage
• Cas d'utilisation
• Annonces
• Comment contribuer
• Dépannage
• À propos
• Soutien
• Licence

Installation

Conditions préalables

• Python version 2.7+
• Le service SendGrid, à partir du niveau gratuit

Configurer les variables d'environnement

Mac

Mettez à jour l'environnement de développement avec votre SENDGRID_API_KEY (plus d'infos ici), par exemple :

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

SendGrid prend également en charge le fichier d'environnement local .env . Copiez ou renommez .env_sample en .env et mettez à jour SENDGRID_API_KEY avec votre clé.

Fenêtres

Définir temporairement la variable d'environnement (accessible uniquement pendant la session cli en cours) :

 set SENDGRID_API_KEY=YOUR_API_KEY

Définir de manière permanente la variable d'environnement (accessible dans toutes les sessions cli suivantes) :

setx SENDGRID_API_KEY " YOUR_API_KEY " 

Installer le package

pip install sendgrid

Dépendances

• Client HTTP Python
• ECDSA-Python

Démarrage rapide

Bonjour E-mail

Voici le code minimum nécessaire pour envoyer un e-mail avec l'assistant /mail/send (voici un exemple complet) :

Avec la classe Mail Helper

 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 )

Le constructeur Mail crée un objet de personnalisation pour vous. Voici un exemple de la façon de l'ajouter.

Sans classe d'assistance de messagerie

Voici le code minimum nécessaire pour envoyer un e-mail sans l'assistant /mail/send (voici un exemple complet) :

 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 )

Utilisation générale de l'API Web v3 (avec interface Fluent)

 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 )

Utilisation générale de l'API Web v3 (sans interface Fluent)

 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 )

Traitement des e-mails entrants

Veuillez consulter notre assistant pour utiliser notre webhook Inbound Parse.

Usage

• Documentation SendGrid
• Documentation sur l'utilisation de la bibliothèque
• Exemple de code
• Comment : Migration de la v2 vers la v3
• v3 Web API Mail Send Helper - créez une charge utile d'objet de requête pour un appel API v3 /mail/send.
• Traitement des e-mails entrants

Cas d'utilisation

Exemples de cas d'utilisation courants de l'API, par exemple comment envoyer un e-mail avec un modèle transactionnel.

Annonces

Toutes les mises à jour de cette bibliothèque sont documentées dans notre CHANGELOG et nos versions.

Comment contribuer

Nous encourageons la contribution à nos bibliothèques (vous pourriez même gagner de jolis cadeaux), veuillez consulter notre guide CONTRIBUER pour plus de détails.

Liens rapides :

• Demande de fonctionnalité
• Rapports de bogues
• Améliorations de la base de code
• Examiner les demandes de tirage

Dépannage

Veuillez consulter notre guide de dépannage pour les problèmes courants de bibliothèque.

À propos

sendgrid-python est géré et financé par Twilio SendGrid, Inc. Les noms et logos de sendgrid-python sont des marques commerciales de Twilio SendGrid, Inc.

Soutien

Si vous avez besoin d'assistance, veuillez consulter le centre d'aide du support Twilio SendGrid.

Licence

La licence MIT (MIT)