Skip to main content

SendGrid library for Python

Project description

This library allows you to quickly and easily send emails through SendGrid using Python.

Warning! This library was recently updated to bring it up to date with all of our other libraries. It behaves completely different from the previous release. Also, SMTP has been deprecated in support for the Web API.

Install

pip install sendgrid
# or
easy_install sendgrid

Example

import sendgrid

sg = sendgrid.SendGridClient('YOUR_SENDGRID_USERNAME', 'YOUR_SENDGRID_PASSWORD')

message = sendgrid.Mail()
message.add_to('John Doe <john@email.com>')
message.set_subject('Example')
message.set_html('Body')
message.set_text('Body')
message.set_from('Doe John <doe@email.com>')
status, msg = sg.send(message)

#or

message = sendgrid.Mail(to='john@email.com', subject='Example', html='Body', text='Body', from_email='doe@email.com')
status, msg = sg.send(message)

Adding Recipients

message = sendgrid.Mail()
message.add_to('example@email.com')
# or
message.add_to('Example Dude <example@email.com>')
# or
message.add_to(['Example Dude <example@email.com>', 'john@email.com'])

Adding BCC Recipients

message = sendgrid.Mail()
message.add_bcc('example@email.com')
# or
message.add_bcc(['Example Dude <example@email.com>', 'john@email.com'])

Setting the Subject

message = sendgrid.Mail()
message.set_subject('Example')

Set Text or HTML

message = sendgrid.Mail()
message.set_text('Body')
# or
message.set_html('<html><body>Stuff, you know?</body></html>')

Set From

message = sendgrid.Mail()
message.set_from('example@email.com')

Set ReplyTo

message.sendgrid.Mail()
message.set_replyto('example@email.com')

Set File Attachments

message = sendgrid.Mail()
message.add_attachment('./stuff.txt')
# or
message.add_attachment_stream('filename', 'somerandomcontentyouwant')
# strings, unicode, or BytesIO streams

SendGrid’s X-SMTPAPI

If you wish to use the X-SMTPAPI on your own app, you can use the SMTPAPI Python library.

There are implementations for setter methods too.

Substitution

message = sendgrid.Mail()
message.add_substitution("key", "value")

Section

message = sendgrid.Mail()
message.add_section("section", "value")

Category

message = sendgrid.Mail()
message.add_category("category")

Unique Arguments

message = sendgrid.Mail()
message.add_unique_arg("key", "value")

Filter

message = sendgrid.Mail()
message.add_filter("filter", "setting", "value")

TODO:

  • Add support for CID

Tests

python test/__init__.py

MIT License

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sendgrid-0.4.1.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sendgrid-0.4.1.macosx-10.9-intel.exe (71.8 kB view details)

Uploaded Source

File details

Details for the file sendgrid-0.4.1.tar.gz.

File metadata

  • Download URL: sendgrid-0.4.1.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for sendgrid-0.4.1.tar.gz
Algorithm Hash digest
SHA256 76e5ee47d588059d48b172141a3706ce66d0ad694e7f48e72cf6266a0073b99e
MD5 f0706d6618e202fb7ae29c136c1e482d
BLAKE2b-256 9581a9035535af7826921cccd00a5eee64f2ce587d64d6b27d4cbd07f2d9f7cb

See more details on using hashes here.

File details

Details for the file sendgrid-0.4.1.macosx-10.9-intel.exe.

File metadata

File hashes

Hashes for sendgrid-0.4.1.macosx-10.9-intel.exe
Algorithm Hash digest
SHA256 d5e2b8dc323962cebf95d2d8332b66d47f5c27dbbbdcca4d1c1e904d3e55b8d1
MD5 adb81ed3a31226dba1b1e29b2faaaf01
BLAKE2b-256 cb46d805d8bf2d9c9ebc89df6d847f5414ac0b1a4400e072ca9a7200bb622345

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page