How to enable sandbox

[SimoMay]

Issue Summary

How to enable "sandbox" mode, using only "@sendgrid/mail"

Technical details:

• @sendgrid/mail: 6.1.4
• Node.js Version: 8.9.0

[thinkingserious]

Hi @CrazyGentleman,

My apologies, it seems that we have left out that use case here. It should be within mail_settings. Here is the complete payload for reference.

I've added this to our backlog.

For this issue to gain priority in our backlog, we need additional +1's or a PR. When we receive a PR, that provides the biggest jump in priority.

Thanks!

With Best Regards,

Elmer

[acaua]

How is the plan to add "sandbox" mode to "@sendgrid/mail" going?

Is there an alternative to use sandbox meanwhile?

Thanks!

[notdmart]

As mentioned above, it is possible to send in sandbox mode, but it's not explicitly shown in the use cases. One of the fields within the body of what you're sending is mailSettings.sandboxMode.enable. Setting this to true will send the email in sandbox mode.
For example:

import * as SendGrid from '@sendgrid/mail';
import { MailData } from '@sendgrid/helpers/classes/mail';

import { Email } from '../models';
import config from '../config';

export function send(email: Email): Promise<any> {
    SendGrid.setApiKey(config.services.email.apiKey);

    const mailSettings = config.services.email.options;
    const data: MailData = {
        ...email,
        ...mailSettings
    };
    // This will send the email in sandbox mode
    data.mailSettings.sandboxMode.enable = true;

    return SendGrid.send(data);
}

[vicpon]

Does the email show up in the dashboard when sandbox mode is enabled?

[thinkingserious]

@victor-ponce,

I don't think so.

[notdmart]

#850 to add this documentation

[ferarnoled]

For V3 here's the snippet

const sgMail = require('@sendgrid/mail');
sgMail.setApiKey(process.env.SENDGRID_API_KEY);
const msg = {
  to: 'recipient@example.org',
  from: 'sender@example.org',
  subject: 'Hello world',
  text: 'Hello plain world!',
  html: 'Hello HTML world!',
  templateId: 'd-f43daeeaef504760851f727007e0b5d0',
  dynamic_template_data: {
    subject: 'Testing Templates',
    name: 'Some One',
    city: 'Denver',
  },
  mail_settings: {
    sandbox_mode: {
      enable: true
    }
  },
};
sgMail.send(msg);

[malimccalla]

Is this not possible? My current sendgrid file looks like this

import sgMail from '@sendgrid/mail';

const sendGridApiKey = process.env.SENDGRID_API_KEY;

if (!sendGridApiKey) {
  throw new Error('The sendgrid api key has not been set in the environment variables');
}

sgMail.setApiKey(sendGridApiKey);

// I need to be able to do something like this
sgMail.enableSandbox(process.env.NODE_ENV !== 'production')

export { sgMail };

It would be great if eventually sendgrid allowed you to generate sandbox api keys much like stripe test keys

[childish-sambino]

PR merged to add this to the docs.

@malimccalla That's not currently supported. Since it's not quite the same as the original request, could you open a new issue to track this?

[malimccalla]

@childish-sambino Done! #1128