To help you get started, we've collected the most common ways that @sendgrid/helpers is being used within popular public projects.

looker / actions / src / integrations / looker / test_looker_dashboard_api.ts View on Github

request.scheduledPlan = {
        title: "Hello attachment",
        url: "https://mycompany.looker.com/look/1",
      }
      request.formParams = {
        to: "test@example.com",
      }
      request.attachment = {dataJSON: {
        fields: [{name: "coolfield", tags: ["looker_dashboard_url"]}],
        data: [
          {coolfield: {value: "/dashboards/1?myfield=Yes"}},
        ],
      }}
      const url = "https://mycompany.looker.com/dashboards/1?myfield=Yes"
      /* tslint:disable max-line-length */
      const msg = new helpers.classes.Mail({
        to: request.formParams.to!,
        subject: request.scheduledPlan.title!,
        from: "Looker ",
        text: `View this data in Looker. ${url}\nResults are attached.`,
        html: `<p>View this data in Looker.</p><p><a href="${url}">${request.scheduledPlan.title!} 0</a></p><p>Results are attached.</p>`,
      })
      msg.addAttachment({
        content: "pdf content",
        filename: sanitizeFilename("Hello attachment_0.pdf"),
        type: "application/pdf",
      })
      return expectLookerAPIActionMatch(request, "/dashboards/1?myfield=Yes", msg)
    })

View more ways to use @sendgrid/helpers

This package is part of a monorepo, please see this README for details.

Support classes and helpers for the SendGrid NodeJS libraries

This is a collection of classes and helpers used internally by the SendGrid NodeJS libraries.

Note that not all objects represented in the SendGrid API have helper classes assigned to them because it is not expected that developers will use these classes themselves. They are primarily for internal use and developers are expected to use the publicly exposed API in the various endpoint services.

Mail class

Used to compose a Mail object that converts itself to proper JSON for use with the SendGrid v3 API. This class supports a slightly different API to make sending emails easier in many cases by not having to deal with personalization arrays, instead offering a more straightforward interface for composing emails.

Attachment class

Used by the inbound mail parser to compose Attachment objects.

Personalization class

Used by the Mail class to compose Personalization objects.

Email address

Helper class to represent an email address with name/email. Used by both the Mail and Personalization classes to deal with email addresses of various formats.

Helpers

Internal helpers that mostly speak for themselves.

How to Contribute

We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.

• Feature Request
• Bug Reports
• Improvements to the Codebase

About

@sendgrid/helpers are maintained and funded by Twilio SendGrid, Inc. The names and logos for @sendgrid/helpers are trademarks of Twilio SendGrid, Inc.

If you need help installing or using the library, please check the Twilio SendGrid Support Help Center.

If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!