sendgrid-python API reference

61 public APIs from sendgrid-python (sendgrid/sendgrid-python) — 40 classes, 0 functions, 21 methods. Signatures extracted by static analysis of the actual source.

Repository: sendgrid/sendgrid-python

Kind	Count
Classes	40
Functions	0
Methods	21

API list

classsendgrid.helpers.eventwebhook.EventWebhook

This class allows you to use the Event Webhook feature.

classsendgrid.helpers.inbound.config.Config

All configuration for this app is loaded here

methodsendgrid.helpers.inbound.config.Config.host()

URL that the sender will POST to.

methodsendgrid.helpers.inbound.config.Config.keys()

Incoming Parse fields to parse.

methodsendgrid.helpers.inbound.config.Config.port()

Port to listen on.

methodsendgrid.helpers.inbound.send.Send.url()

URL to send to.

classsendgrid.helpers.mail.amp_html_content.AmpHtmlContent

AMP HTML content to be included in your email.

methodsendgrid.helpers.mail.amp_html_content.AmpHtmlContent.content()

The actual AMP HTML content.

classsendgrid.helpers.mail.asm.Asm

An object specifying unsubscribe behavior.

classsendgrid.helpers.mail.attachment.Attachment

An attachment to be included with an email.

classsendgrid.helpers.mail.bcc_email.Bcc

A bcc email address with an optional name.

classsendgrid.helpers.mail.bcc_settings.BccSettings

Settings object for automatic BCC.

classsendgrid.helpers.mail.bcc_settings_email.BccSettingsEmail

The BccSettingsEmail of an Attachment.

classsendgrid.helpers.mail.category.Category

A category name for this message.

methodsendgrid.helpers.mail.category.Category.name()

The name of this Category.

classsendgrid.helpers.mail.cc_email.Cc

A cc email address with an optional name.

classsendgrid.helpers.mail.content.Content

Content to be included in your email.

classsendgrid.helpers.mail.content_id.ContentId

The ContentId of an Attachment.

classsendgrid.helpers.mail.email.Email

An email address with an optional name.

methodsendgrid.helpers.mail.email.Email.email()

Email address.

methodsendgrid.helpers.mail.email.Email.name()

Name associated with this email.

methodsendgrid.helpers.mail.email.Email.substitutions()

A list of Substitution objects.

classsendgrid.helpers.mail.exceptions.SendGridException

Wrapper/default SendGrid-related exception

classsendgrid.helpers.mail.file_content.FileContent

The Base64 encoded content of an Attachment.

classsendgrid.helpers.mail.file_name.FileName

The filename of an Attachment.

methodsendgrid.helpers.mail.file_name.FileName.file_name()

The file name of the attachment.

classsendgrid.helpers.mail.footer_html.FooterHtml

The HTML in a Footer.

classsendgrid.helpers.mail.footer_text.FooterText

The text in an Footer.

classsendgrid.helpers.mail.from_email.From

A from email address with an optional name.

classsendgrid.helpers.mail.group_id.GroupId

The unsubscribe group ID to associate with this email.

methodsendgrid.helpers.mail.header.Header.key()

The name of the header.

methodsendgrid.helpers.mail.header.Header.value()

The value of the header.

classsendgrid.helpers.mail.html_content.HtmlContent

HTML content to be included in your email.

methodsendgrid.helpers.mail.html_content.HtmlContent.content()

The actual HTML content.

classsendgrid.helpers.mail.mail.Mail

Creates the response body for v3/mail/send

classsendgrid.helpers.mail.mime_type.MimeType

The MIME type of the content included in your email.

classsendgrid.helpers.mail.plain_text_content.PlainTextContent

Plain text content to be included in your email.

methodsendgrid.helpers.mail.plain_text_content.PlainTextContent.content()

The actual text content.

methodsendgrid.helpers.mail.plain_text_content.PlainTextContent.mime_type()

The MIME type.

classsendgrid.helpers.mail.reply_to.ReplyTo

A reply to email address with an optional name.

classsendgrid.helpers.mail.sandbox_mode.SandBoxMode

Setting for sandbox mode.

classsendgrid.helpers.mail.section.Section

A block section of code to be used as a substitution.

methodsendgrid.helpers.mail.section.Section.key()

A section of code's key.

methodsendgrid.helpers.mail.section.Section.value()

A section of code's value.

classsendgrid.helpers.mail.subject.Subject

A subject for an email message.

methodsendgrid.helpers.mail.subject.Subject.subject()

The subject of an email.

classsendgrid.helpers.mail.subscription_html.SubscriptionHtml

The HTML of an SubscriptionTracking.

classsendgrid.helpers.mail.subscription_text.SubscriptionText

The text of an SubscriptionTracking.

classsendgrid.helpers.mail.template_id.TemplateId

The template ID of an Attachment object.

classsendgrid.helpers.mail.to_email.To

A to email address with an optional name.

classsendgrid.helpers.mail.utm_campaign.UtmCampaign

The utm campaign of an Ganalytics object.

classsendgrid.helpers.mail.utm_content.UtmContent

The utm content of an Ganalytics object.

classsendgrid.helpers.mail.utm_medium.UtmMedium

The utm medium of an Ganalytics object.

methodsendgrid.helpers.mail.utm_medium.UtmMedium.utm_medium()

Name of the marketing medium.

classsendgrid.helpers.mail.utm_source.UtmSource

The utm source of an Ganalytics object.

methodsendgrid.helpers.mail.utm_source.UtmSource.utm_source()

Name of the referrer source.

classsendgrid.helpers.mail.utm_term.UtmTerm

The utm term of an Ganalytics object.

classsendgrid.helpers.mail.validators.ValidateApiKey

Validates content to ensure SendGrid API key is not present

methodsendgrid.helpers.stats.stats.Stats.aggregated_by()

Chosen period (e.g.

classsendgrid.sendgrid.SendGridAPIClient

The Twilio SendGrid API Client.

classsendgrid.twilio_email.TwilioEmailAPIClient

The Twilio Email API Client.

About this data

These signatures were extracted from the public source of sendgrid/sendgrid-python using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries