examples

Nylas Node.js SDK Examples

This directory contains examples of how to use the Nylas Node.js SDK to interact with the Nylas API.

Examples

Node.js Examples

• Grants - Examples of how to fetch, list, sort, and filter grants (authenticated connections to email/calendar providers).
• Notetakers - Examples of how to use the Nylas Notetakers API to invite a Notetaker bot to meetings, get recordings and transcripts, and more.
• Messages - Examples of how to use the Nylas Messages API to list, find, send, update messages, and work with new features like tracking options and raw MIME data.
• Folders - Examples of how to use the Nylas Folders API, including the new singleLevel parameter for Microsoft accounts.
• Calendars - Examples of how to use the Nylas Calendar API to create and manage calendar events with Notetaker integration.
• Agent Accounts - Examples of how to use Agent Account Policies, Rules, Lists, provisioning, and rule evaluations.

Cloudflare Workers Examples

• Cloudflare Vite Calendars - Modern Cloudflare Workers example using Vite for building a calendar event manager. Showcases listing and creating events with a beautiful web interface.
• Edge Environment - Standard Cloudflare Workers example for sending email attachments. Demonstrates file upload handling and email sending on the edge.

AWS Lambda Examples

• AWS Lambda Attachments - AWS Lambda example for sending email attachments using the Nylas SDK. Demonstrates how to handle multiple file uploads (including 2+ attachments over 3MB total) without Lambda freezing. Includes interactive setup CLI and Serverless Framework deployment.

Module System Examples

• ESM Only - Example of using the SDK with ES Modules
• CJS Only - Example of using the SDK with CommonJS

Running the Examples

Node.js Examples

To run the Node.js examples, you'll need to:

1. Install dependencies:

   cd examples
   npm install

2. Copy the .env.example file to .env and fill in your API key:

   cp .env.example .env
   # Edit .env with your editor and add your API key

3. Set up the required environment variables in the .env file:

   • NYLAS_API_KEY - Your Nylas API key
   • NYLAS_API_URI (optional) - The Nylas API server URI (defaults to "https://api.us.nylas.com")
   • Additional environment variables specific to each example

4. Run the example:

   # Using ts-node
   npx ts-node grants/grants.ts
   npx ts-node notetakers/notetaker.ts
   npx ts-node calendars/event_with_notetaker.ts
   npx ts-node messages/messages.ts
   
   # Or using npm scripts
   npm run grants
   npm run notetakers
   npm run calendars
   npm run messages
   npm run agent-accounts
   
   # Or if you compiled the examples
   npm run build
   node dist/grants/grants.js
   node dist/notetakers/notetaker.js
   node dist/calendars/event_with_notetaker.js
   node dist/messages/messages.js
   node dist/agent-accounts/agent-accounts.js

Cloudflare Workers Examples

The Cloudflare Workers examples are self-contained and have their own setup:

1. Navigate to the example directory:

   cd examples/cloudflare-vite-calendars
   # or
   cd examples/edge-environment

2. Install dependencies:

   npm install

3. Set up environment variables (see each example's README for details):

   cp .dev.vars.example .dev.vars
   # Edit .dev.vars with your Nylas credentials

4. Run the development server:

   npm run dev

5. Deploy to Cloudflare (optional):

   npm run deploy

Each Cloudflare example has its own comprehensive README with detailed instructions.

AWS Lambda Examples

The AWS Lambda example is self-contained and has its own setup:

1. Navigate to the example directory:

   cd examples/aws-lambda

2. Run the interactive setup:

   npm run setup

   This will guide you through:

   • Prerequisites checking
   • Nylas credentials configuration
   • AWS credentials setup
   • Environment variable configuration
   • Optional immediate deployment

3. Or set up manually:

   npm install
   # Create .env file with your Nylas credentials
   # Configure AWS credentials
   npm run deploy

4. Test the deployed function:

   • Visit the API Gateway URL displayed after deployment
   • Upload multiple files and send emails
   • Test with files totaling over 3MB to verify the bug fix

The AWS Lambda example includes a comprehensive README with detailed instructions and troubleshooting.

Documentation

For more information, see the Nylas API Documentation.