sendgrid python

Mit dieser Bibliothek können Sie die SendGrid Web API v3 schnell und einfach über Python nutzen.

Version 3.X.X+ dieser Bibliothek bietet vollständige Unterstützung für alle SendGrid Web API v3-Endpunkte, einschließlich der neuen v3 /mail/send.

Diese Bibliothek stellt den Beginn eines neuen Weges für SendGrid dar. Wir möchten, dass diese Bibliothek von der Community betrieben und von SendGrid geleitet wird. Um dieses Ziel zu erreichen, benötigen wir Ihre Hilfe. Um sicherzustellen, dass wir die richtigen Dinge in der richtigen Reihenfolge erstellen, bitten wir Sie, Probleme und Pull-Anfragen zu erstellen oder einfach bestehende Probleme oder Pull-Anfragen positiv zu bewerten oder zu kommentieren.

Wenn Sie Hilfe bei der Verwendung von SendGrid benötigen, schauen Sie bitte im Twilio SendGrid Support Help Center nach.

Weitere Informationen finden Sie im Rest dieser README-Datei.

Inhaltsverzeichnis

• Installation
• Schnellstart
• Verarbeitung eingehender E-Mails
• Verwendung
• Anwendungsfälle
• Ankündigungen
• So können Sie einen Beitrag leisten
• Fehlerbehebung
• Um
• Unterstützung
• Lizenz

Installation

Voraussetzungen

• Python-Version 2.7+
• Der SendGrid-Dienst, beginnend auf der kostenlosen Ebene

Umgebungsvariablen einrichten

Mac

Aktualisieren Sie die Entwicklungsumgebung mit Ihrem SENDGRID_API_KEY (weitere Informationen hier), zum Beispiel:

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

SendGrid unterstützt auch die lokale Umgebungsdatei .env . Kopieren Sie .env_sample oder benennen Sie es in .env um und aktualisieren Sie SENDGRID_API_KEY mit Ihrem Schlüssel.

Windows

Legen Sie vorübergehend die Umgebungsvariable fest (nur während der aktuellen CLI-Sitzung zugänglich):

 set SENDGRID_API_KEY=YOUR_API_KEY

Legen Sie die Umgebungsvariable dauerhaft fest (zugänglich in allen nachfolgenden CLI-Sitzungen):

setx SENDGRID_API_KEY " YOUR_API_KEY " 

Paket installieren

pip install sendgrid

Abhängigkeiten

• Python-HTTP-Client
• ECDSA-Python

Schnellstart

Hallo E-Mail

Der folgende Code ist mindestens erforderlich, um eine E-Mail mit dem /mail/send-Helper zu senden (hier ist ein vollständiges Beispiel):

Mit Mail Helper-Klasse

 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 )

Der Mail Konstruktor erstellt ein Personalisierungsobjekt für Sie. Hier ist ein Beispiel dafür, wie man es hinzufügt.

Ohne Mail-Helper-Klasse

Der folgende Code ist mindestens erforderlich, um eine E-Mail ohne den /mail/send-Helfer zu senden (hier ist ein vollständiges Beispiel):

 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 )

Allgemeine v3-Web-API-Nutzung (mit Fluent-Schnittstelle)

 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 )

Allgemeine v3-Web-API-Nutzung (ohne Fluent-Schnittstelle)

 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 )

Verarbeitung eingehender E-Mails

Weitere Informationen zur Verwendung unseres Inbound Parse-Webhooks finden Sie in unserem Helfer.

Verwendung

• SendGrid-Dokumentation
• Dokumentation zur Bibliotheksnutzung
• Beispielcode
• Anleitung: Migration von v2 auf v3
• v3 Web API Mail Send Helper – Erstellen Sie eine Anforderungsobjekt-Nutzlast für einen v3 /mail/send API-Aufruf.
• Verarbeitung eingehender E-Mails

Anwendungsfälle

Beispiele für gängige API-Anwendungsfälle, z. B. das Versenden einer E-Mail mit einer Transaktionsvorlage.

Ankündigungen

Alle Aktualisierungen dieser Bibliothek sind in unserem CHANGELOG und unseren Releases dokumentiert.

So können Sie einen Beitrag leisten

Wir ermutigen Sie, zu Beiträgen in unseren Bibliotheken beizutragen (vielleicht ergattern Sie sogar ein paar tolle Geschenke). Weitere Informationen finden Sie in unserem Leitfaden „Beiträge leisten“.

Quicklinks:

• Funktionsanfrage
• Fehlerberichte
• Verbesserungen an der Codebasis
• Überprüfen Sie Pull-Anfragen

Fehlerbehebung

Weitere Informationen zu häufigen Bibliotheksproblemen finden Sie in unserem Leitfaden zur Fehlerbehebung.

Um

sendgrid-python wird von Twilio SendGrid, Inc. gepflegt und finanziert. Die Namen und Logos für sendgrid-python sind Marken von Twilio SendGrid, Inc.

Unterstützung

Wenn Sie Unterstützung benötigen, schauen Sie bitte im Twilio SendGrid Support Help Center nach.

Lizenz

Die MIT-Lizenz (MIT)