Retrieve address whitelist mail settings · Email Activity (beta)

provider Settings - Mail GET /mail_settings/address_whitelist

@utdk/sendgrid /mail_settings/address_whitelist

Retrieve address whitelist mail settings

**This endpoint allows you to retrieve your current email address whitelist settings.** The Address Whitelist setting allows you to specify email addresses or domains for which mail should never be suppressed. For example, if you own the domain `example.com`, and one or more of your recipients use `email@example.com` addresses, placing `example.com` in the address whitelist setting instructs Twilio SendGrid to ignore all bounces, blocks, and unsubscribes logged for that domain. In other words, all bounces, blocks, and unsubscribes will still be sent to `example.com` as if they were sent under normal sending conditions.

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.

Execution Mode

Gateway URL

Saved automatically to browser storage.

Code snippet

Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

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