Menu

Expand
Rate this page:

Settings - Mail

Mail Settings instruct SendGrid to apply specific settings to every email that you send over SendGrid’s v3 API or SMTP Relay. These settings include how to embed a custom footer, how to manage blocks, spam, and bounces, and more.

For a full list of Twilio SendGrid's Mail Settings, and what each one does, see our Mail Settings documentation.

You can also manage your Mail Settings in the Twilio SendGrid App

Retrieve bounce purge mail settings

GET /v3/mail_settings/bounce_purge

Base url: https://api.sendgrid.com

This endpoint allows you to retrieve your current bounce and purge settings.

The Bounce Perge setting allows you to set a schedule that Twilio SendGrid will use to automatically delete contacts from your soft and hard bounce suppression lists.

A hard bounce occurs when an email message has been returned to the sender because the recipient's address is invalid. A hard bounce might occur because the domain name doesn't exist or because the recipient is unknown.

A soft bounce occurs when an email message reaches the recipient's mail server but is bounced back undelivered before it actually reaches the recipient. A soft bounce might occur because the recipient's inbox is full.

You can also manage this setting in the Mail Settings section of the Twilio SendGrid App. You can manage your bounces manually using the Bounces API or the Bounces menu in the Twilio SendGrid App.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string

The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.

default: None

Responses

object
enabled
boolean

Indicates if the bounce purge mail setting is enabled.

soft_bounces
integer or null

The number of days after which SendGrid will purge all contacts from your soft bounces suppression lists.

hard_bounces
integer or null

The number of days after which SendGrid will purge all contacts from your hard bounces suppression lists.

{
  "enabled": false,
  "soft_bounces": 1234,
  "hard_bounces": 1234
}
object
errors
array[object]
error_id
string

The ID associated with the error.

field
string or null

The field that generated the error.

message
string

The error message.

required
parameter
string
object
errors
array[object]
error_id
string

The ID associated with the error.

field
string or null

The field that generated the error.

message
string

The error message.

required
parameter
string
object
errors
array[object]
error_id
string

The ID associated with the error.

field
string or null

The field that generated the error.

message
string

The error message.

required
parameter
string
object
errors
array[object]
error_id
string

The ID associated with the error.

field
string or null

The field that generated the error.

message
string

The error message.

required
parameter
string
object
errors
array[object]
error_id
string

The ID associated with the error.

field
string or null

The field that generated the error.

message
string

The error message.

required
parameter
string
Loading Code Sample...
        
        

        Retrieve bounce purge mail settings

        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

        Loading Code Sample...
              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif