Skip to content

data-residency-set-hostname.md

Latest commit

 

History

History
38 lines (34 loc) · 1.31 KB

data-residency-set-hostname.md

File metadata and controls

38 lines (34 loc) · 1.31 KB

Choosing a hostname to send messages to

Use the setDataResidency setter to specify which host to send to:

Send to EU (hostname: https://api.eu.sendgrid.com/)

const sgMail = require('@sendgrid/mail');
sgMail.setDataResidency('eu');
const msg = {
  to: 'recipient@example.org',
  from: 'sender@example.org',
  subject: 'Hello world',
  text: 'Hello plain world!',
  html: '<p>Hello HTML world!</p>',
};
sgMail.send(msg);

Send to Global region, this is also the default host, if the setter is not used (hostname: https://api.sendgrid.com/)

const sgMail = require('@sendgrid/mail');
sgMail.setDataResidency('global');
const msg = {
  to: 'recipient@example.org',
  from: 'sender@example.org',
  subject: 'Hello world',
  text: 'Hello plain world!',
  html: '<p>Hello HTML world!</p>',
};
sgMail.send(msg);

Limitations

  1. Setting the API Key (via client.setApiKey()) or Twilio Authentication (via client.setTwilioEmailAuth()) will override the hostname to default value. Use the setter call after this set-up.
  2. Emails can only be sent to two hosts for now; 'eu' (https://api.eu.sendgrid.com/) and 'global' (https://api.eu.sendgrid.com/)
  3. The default hostname is https://api.sendgrid.com/
  4. The valid values for region in client.setDataResidency(region) are only eu and global. Case-sensitive.