このライブラリを使用すると、Python 経由で SendGrid Web API v3 をすばやく簡単に使用できます。
このライブラリのバージョン 3.X.X+ は、新しい v3 /mail/send を含むすべての SendGrid Web API v3 エンドポイントを完全にサポートします。
このライブラリは、SendGrid の新しいパスの始まりを表します。私たちは、このライブラリがコミュニティ主導型であり、SendGrid 主導型になることを望んでいます。この目標を実現するにはあなたの助けが必要です。正しいものを正しい順序で構築していることを確認するために、問題やプル リクエストを作成するか、既存の問題やプル リクエストに賛成票を投じたり、コメントしたりしてください。
SendGrid の使用に関するサポートが必要な場合は、Twilio SendGrid サポート ヘルプ センターをご確認ください。
詳細については、この README の残りの部分を参照してください。
SENDGRID_API_KEY を使用して開発環境を更新します (詳細はこちら)。次に例を示します。
echo " export SENDGRID_API_KEY='YOUR_API_KEY' " > sendgrid.env
echo " sendgrid.env " >> .gitignore
source ./sendgrid.env
SendGrid はローカル環境ファイル.env
もサポートしています。 .env_sample
を.env
にコピーまたは名前変更し、SENDGRID_API_KEY をキーで更新します。
環境変数を一時的に設定します (現在の cli セッション中にのみアクセス可能)。
set SENDGRID_API_KEY=YOUR_API_KEY
環境変数を永続的に設定します (後続のすべての cli セッションでアクセス可能):
setx SENDGRID_API_KEY " YOUR_API_KEY "
pip install sendgrid
/mail/send ヘルパーを使用して電子メールを送信するために最低限必要なコードは次のとおりです (完全な例は次のとおりです)。
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 )
Mail
コンストラクターはパーソナライゼーション オブジェクトを作成します。追加方法の例を次に示します。
/mail/send ヘルパーを使用せずに電子メールを送信するために最低限必要なコードは次のとおりです (完全な例は次のとおりです)。
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 )
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 )
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 )
Inbound Parse Webhook の利用については、ヘルパーを参照してください。
一般的な API の使用例 (トランザクション テンプレートを使用して電子メールを送信する方法など)。
このライブラリに対するすべての更新は、CHANGELOG とリリースに文書化されています。
私たちはライブラリへの貢献を奨励しています (素敵なグッズを獲得することもできます)。詳細については、貢献ガイドをご覧ください。
クイックリンク:
一般的なライブラリの問題については、トラブルシューティング ガイドを参照してください。
sendgrid-python は Twilio SendGrid, Inc. によって維持および資金提供されています。sendgrid-python の名前とロゴは Twilio SendGrid, Inc. の商標です。
サポートが必要な場合は、Twilio SendGrid サポート ヘルプ センターをご確認ください。
MIT ライセンス (MIT)