sendgrid python

Pustaka ini memungkinkan Anda menggunakan SendGrid Web API v3 dengan cepat dan mudah melalui Python.

Versi 3.X.X+ perpustakaan ini memberikan dukungan penuh untuk semua titik akhir SendGrid Web API v3, termasuk v3 baru /mail/send.

Pustaka ini mewakili awal jalur baru untuk SendGrid. Kami ingin perpustakaan ini didorong oleh komunitas dan dipimpin oleh SendGrid. Kami membutuhkan bantuan Anda untuk mewujudkan tujuan ini. Untuk membantu memastikan kami menyusun hal yang benar dalam urutan yang benar, kami meminta Anda membuat masalah dan menarik permintaan atau cukup memberi suara positif atau mengomentari masalah yang ada atau menarik permintaan.

Jika Anda memerlukan bantuan dalam menggunakan SendGrid, silakan periksa Pusat Bantuan Dukungan Twilio SendGrid.

Silakan telusuri sisa README ini untuk detail lebih lanjut.

Daftar isi

• Instalasi
• Mulai Cepat
• Memproses Email Masuk
• Penggunaan
• Kasus Penggunaan
• Pengumuman
• Bagaimana Berkontribusi
• Pemecahan masalah
• Tentang
• Mendukung
• Lisensi

Instalasi

Prasyarat

• Python versi 2.7+
• Layanan SendGrid, dimulai dari level gratis

Variabel Lingkungan Pengaturan

Mac

Perbarui lingkungan pengembangan dengan SENDGRID_API_KEY Anda (info lebih lanjut di sini), misalnya:

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

SendGrid juga mendukung file lingkungan lokal .env . Salin atau ganti nama .env_sample menjadi .env dan perbarui SENDGRID_API_KEY dengan kunci Anda.

jendela

Atur sementara variabel lingkungan (hanya dapat diakses selama sesi cli saat ini):

 set SENDGRID_API_KEY=YOUR_API_KEY

Atur variabel lingkungan secara permanen (dapat diakses di semua sesi cli berikutnya):

setx SENDGRID_API_KEY " YOUR_API_KEY " 

Instal Paket

pip install sendgrid

Ketergantungan

• Klien-HTTP-Python
• ECDSA-Python

Mulai Cepat

Halo Email

Berikut kode minimum yang diperlukan untuk mengirim email dengan Helper /mail/send (berikut contoh lengkapnya):

Dengan Kelas Pembantu Surat

 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 )

Konstruktor Mail membuat objek personalisasi untuk Anda. Berikut ini contoh cara menambahkannya.

Tanpa Kelas Pembantu Surat

Berikut kode minimum yang dibutuhkan untuk mengirim email tanpa Helper /mail/send (berikut contoh lengkapnya):

 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 )

Penggunaan API Web v3 Umum (Dengan Antarmuka Lancar)

 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 )

Penggunaan API Web v3 Umum (Tanpa Antarmuka Lancar)

 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 )

Memproses Email Masuk

Silakan lihat pembantu kami untuk menggunakan webhook Parse Masuk kami.

Penggunaan

• Dokumentasi SendGrid
• Dokumentasi Penggunaan Perpustakaan
• Contoh Kode
• Cara: Migrasi dari v2 ke v3
• v3 Web API Mail Send Helper - membuat payload objek permintaan untuk panggilan API v3 /mail/send.
• Memproses Email Masuk

Kasus Penggunaan

Contoh kasus penggunaan API yang umum, seperti cara mengirim email dengan template transaksional.

Pengumuman

Semua pembaruan pada perpustakaan ini didokumentasikan dalam CHANGELOG dan rilis kami.

Bagaimana Berkontribusi

Kami mendorong kontribusi ke perpustakaan kami (Anda bahkan mungkin mendapatkan barang curian yang bagus), silakan lihat panduan KONTRIBUSI kami untuk detailnya.

Tautan cepat:

• Permintaan Fitur
• Laporan Bug
• Perbaikan pada Basis Kode
• Tinjau Permintaan Tarik

Pemecahan masalah

Silakan lihat panduan pemecahan masalah kami untuk masalah umum perpustakaan.

Tentang

sendgrid-python dikelola dan didanai oleh Twilio SendGrid, Inc. Nama dan logo sendgrid-python adalah merek dagang dari Twilio SendGrid, Inc.

Mendukung

Jika Anda memerlukan dukungan, silakan periksa Pusat Bantuan Dukungan Twilio SendGrid.

Lisensi

Lisensi MIT (MIT)