provider Settings - Mail GET /mail_settings
@utdk/sendgrid /mail_settings
Retrieve all 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.
limit query
The number of settings to return.
integer
offset query
Where in the list of results to begin displaying settings.
integer
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getMailSettings
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.

The number of settings to return.

Where in the list of results to begin displaying settings.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.getMailSettings({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})