Menu

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 all mail settings

GET /mail_settings

This endpoint allows you to retrieve a list of all mail settings.

Each setting will be returned with an enabled status set to true or false and a short description that explains what the setting does.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Query String

limit
integer

The number of results to return.

default: None
offset
integer

The point in the list to begin retrieving results.

default: None

Responses

object
result
array[object]

The list of all mail settings.

required
title
string

The title of the mail setting.

enabled
boolean

Indicates if this mail setting is currently enabled.

name
string

The name of the mail setting.

description
string

A description of the mail setting.

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.

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.

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.

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.

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.

parameter
string
Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

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

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more