sendgrid python

Esta biblioteca permite que você use de forma rápida e fácil a API Web SendGrid v3 via Python.

A versão 3.X.X+ desta biblioteca fornece suporte completo para todos os endpoints SendGrid Web API v3, incluindo o novo v3 /mail/send.

Esta biblioteca representa o início de um novo caminho para SendGrid. Queremos que esta biblioteca seja dirigida pela comunidade e liderada pelo SendGrid. Precisamos da sua ajuda para concretizar esse objetivo. Para ajudar a garantir que estamos construindo as coisas certas na ordem certa, pedimos que você crie problemas e pull requests ou simplesmente vote positivamente ou comente sobre problemas existentes ou pull requests.

Se precisar de ajuda para usar o SendGrid, consulte o Centro de Ajuda de suporte do Twilio SendGrid.

Por favor, navegue no restante deste README para obter mais detalhes.

Índice

• Instalação
• Início rápido
• Processando e-mail de entrada
• Uso
• Casos de uso
• Anúncios
• Como contribuir
• Solução de problemas
• Sobre
• Apoiar
• Licença

Instalação

Pré-requisitos

• Versão Python 2.7+
• O serviço SendGrid, começando no nível gratuito

Configurar variáveis ​​de ambiente

Mac

Atualize o ambiente de desenvolvimento com seu SENDGRID_API_KEY (mais informações aqui), por exemplo:

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

SendGrid também oferece suporte ao arquivo de ambiente local .env . Copie ou renomeie .env_sample para .env e atualize SENDGRID_API_KEY com sua chave.

Windows

Defina temporariamente a variável de ambiente (acessível apenas durante a sessão cli atual):

 set SENDGRID_API_KEY=YOUR_API_KEY

Defina permanentemente a variável de ambiente (acessível em todas as sessões CLI subsequentes):

setx SENDGRID_API_KEY " YOUR_API_KEY " 

Instalar pacote

pip install sendgrid

Dependências

• Cliente Python-HTTP
• ECDSA-Python

Início rápido

Olá e-mail

A seguir está o código mínimo necessário para enviar um e-mail com o auxiliar /mail/send (aqui está um exemplo completo):

Com classe auxiliar de correio

 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 )

O construtor Mail cria um objeto de personalização para você. Aqui está um exemplo de como adicioná-lo.

Sem classe auxiliar de correio

A seguir está o código mínimo necessário para enviar um e-mail sem o auxiliar /mail/send (aqui está um exemplo 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 geral da API Web v3 (com interface fluente)

 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 geral da API Web v3 (sem interface fluente)

 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 )

Processando e-mail de entrada

Consulte nosso ajudante para utilizar nosso webhook Inbound Parse.

Uso

• Documentação SendGrid
• Documentação de uso da biblioteca
• Código de exemplo
• Como fazer: Migração de v2 para v3
• v3 Web API Mail Send Helper - cria uma carga útil de objeto de solicitação para uma chamada de API v3 /mail/send.
• Processando e-mail de entrada

Casos de uso

Exemplos de casos de uso comuns de API, como enviar um email com um modelo transacional.

Anúncios

Todas as atualizações desta biblioteca estão documentadas em nosso CHANGELOG e lançamentos.

Como contribuir

Incentivamos a contribuição para nossas bibliotecas (você pode até ganhar alguns brindes bacanas). Consulte nosso guia de CONTRIBUIÇÃO para obter detalhes.

Links rápidos:

• Solicitação de recurso
• Relatórios de bugs
• Melhorias na base de código
• Revise solicitações pull

Solução de problemas

Consulte nosso guia de solução de problemas para problemas comuns de biblioteca.

Sobre

sendgrid-python é mantido e financiado pela Twilio SendGrid, Inc. Os nomes e logotipos de sendgrid-python são marcas registradas da Twilio SendGrid, Inc.

Apoiar

Se precisar de suporte, consulte a Central de Ajuda de suporte do Twilio SendGrid.

Licença

A Licença MIT (MIT)