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
This endpoint allows you to update 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. The schedule is set in full days by assigning the number of days, an integer, to the soft_bounces
and/or hard_bounces
fields.
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.
Bearer <<YOUR_API_KEY_HERE>>
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.
application/json
Indicates if the bounce purge mail setting is enabled.
The number of days after which SendGrid will purge all contacts from your soft bounces suppression lists.
The number of days after which SendGrid will purge all contacts from your hard bounces suppression lists.
Indicates if the bounce purge mail setting is enabled.
The number of days after which SendGrid will purge all contacts from your soft bounces suppression lists.
The number of days after which SendGrid will purge all contacts from your hard bounces suppression lists.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const data = {5hard_bounces: 10,6enabled: false,7soft_bounces: 1234,8};910const request = {11url: `/v3/mail_settings/bounce_purge`,12method: "PATCH",13body: data,14};1516client17.request(request)18.then(([response, body]) => {19console.log(response.statusCode);20console.log(response.body);21})22.catch((error) => {23console.error(error);24});