Structures

The Subuser struct represents a subuser on a parent account.

The Block struct represents a block event.

The Bounce struct represents a bounce event.

The GlobalUnsubscribe struct represents an entry on the Global Unsubscribe suppression list.

The InvalidEmail struct represents an entry on the Invalid Email suppression list.

The SpamReport struct represents a spam report event.

The Statistic struct represents the enclosing structure of statistics returning from the various stat API calls. It contains the date of the aggregated time period, along with the raw stats.

The ASM class is used to specify an unsubscribe group to associate the email with.

The Address struct represents an email address and contains the email address along with an optional display name.

The Content class represents a MIME part of the email message (i.e. the plain text and HTML parts of an email).

This allows you to have a blind carbon copy automatically sent to the specified email address for every email that is sent.

The BypassListManagement class allows you to bypass all unsubscribe groups and suppressions to ensure that the email is attempted to be delivered to every single recipient. This should only be used in emergencies when it is absolutely necessary that every recipient receives your email. Ex: outage emails, or forgot password emails.

The Footer mail setting allows you to specify a footer that will be appended to the bottom of every email.

The MailSetting struct houses any mail settings an email should be configured with.

This allows you to send a test email to ensure that your request body is valid and formatted correctly. For more information, please see the SendGrid docs.

The SpamChecker mail setting allows you to test the content of your email for spam.

The ClickTracking class is used to adjust the click tracking setting.

The GoogleAnalytics class is used to toggle the Google Analytics setting, which adds GA parameters to links in the email.

The OpenTracking class is used to toggle the open tracking setting for an email.

The SubscriptionTracking class is used to modify the subscription tracking setting on an email.

The TrackingSettings struct houses any tracking settings an email should be configured with.

The SuppressionListDeleterParameters struct houses all the parameters that can be made for the suppression delete calls.

The SuppressionListReaderParameters serves as the parameters used by the get suppressions API calls.

The Exception struct contains all the errors that the SendGrid-Swift library can throw.

The Authentication struct is used to authenticate all the requests made by Session.

The Constants struct houses all the constant values used throughout the library.

The ContentType struct represents the common types of Content Types used when sending through the SendGrid API.

This struct houses both the date and data decoding strategies for a response.

This struct houses both the date and data encoding strategies for a request.

This struct is used to represent a page via the limit and offset parameters found in various API calls.

The Pagination struct represents all the pagination info that can be returned via an API call, often containing a first, previous, next, and last page. This struct represents all those pages as Page instances.

The RateLimit struct abstracts any rate-limit information returned from an Response.