Skip to content
Skip to main content
/
Documentation
Docs
API Reference
API
Notification Reference
Notifications
UI Reference
UI
Cookbook
Cookbook
Explore
Documentation
Documentation
Guides and tutorials
API Reference
REST API endpoints
Notification Reference
Webhook event schemas
UI Reference
Web components
Cookbook
Recipes and end-to-end use cases
Home
Getting started
What is Nylas
Get started: CLI
Get started: Dashboard
Build with Nylas
Guide for AI coding agents
Quickstart: Email API
Quickstart: Calendar & Events APIs
Quickstart: Notetaker API
Quickstart: Scheduler API
Quickstart: Contacts API
Quickstart: Transactional Send (Beta)
Quickstart: Agent Accounts (Beta)
Nylas for AI Agents
Quickstart: AI agents
Share your email with your agent
Share your calendar with your agent
Give your agent its own email (Beta)
Give your agent its own calendar (Beta)
Give your agent call recordings
Give your agent contacts
Nylas MCP server
Security for AI agents
Authentication
Authenticating with Nylas
Setup guides
Hosted OAuth with API key
Hosted OAuth with access token & PKCE
Bring your own authentication
IMAP authentication
Service account
Nylas Connect
Overview
Nylas Connect JS
Nylas Connect overview
External IDPs
Overview
Auth0
Clerk
Google
WorkOS
Custom IDP
NylasConnect class
NylasConnect class overview
Authentication methods
connect()
getAuthUrl()
onConnectStateChange()
Callback methods
callback()
handleRedirectCallback()
Grant management methods
getConnectionStatus()
getSession()
logout()
Utility methods
setLogLevel()
Nylas Connect React
Nylas Connect React overview
useNylasConnect
External IDPs (React)
Overview
Auth0
Clerk
Google
WorkOS
NylasConnectButton component
Advanced
Bulk authentication grants
Using multiple provider applications
Customize the login prompt
Troubleshooting
Troubleshoot auth errors
Email
Email API
Using the Messages API
Sending messages
Using email signatures
Managing domains
Email Domain Warm Up
Using templates & workflows
Idempotent send requests
Scheduling messages
Sending errors
Parsing messages
Using Smart Compose
Tracking messages
Using the Threads API
Using the Folders API
Using the Attachments API
Send large attachments
Using email headers & MIME data
Using the Contacts API
Calendar
Using the Calendar API
Using virtual calendars
Using the Events API
Checking availability
Checking free/busy information
Group availability & booking
Adding conferencing to events
Recurring events and RRULE
Scheduler
Using Scheduler
Using the Scheduler Editor component
Using the Scheduling component
Hosted Scheduling Pages
Customizing Scheduler
Localizing Scheduler
Scheduler & Notetaker Integration
Meeting types
Managing availability
Adding conferencing to bookings
Customizing booking flows
Retrieving booking IDs
Notetaker
Using Notetaker
Using calendar sync with Notetaker
Handling Notetaker media files
Scheduler & Notetaker Integration
Agent Accounts (Beta)
Using Agent Accounts
Provisioning and domains
Mailboxes
Calendars
Mail client access (IMAP & SMTP)
Supported endpoints
Email threading
Policies, Rules, and Lists
Notifications
Using webhooks
Using a Pub/Sub channel
Using an SNS channel
Receive with CLI
SDKs
Nylas SDKs
Node.js
Overview
Read messages and threads with Node.js
Send messages with Node.js
Manage folders and labels with Node.js
Manage events with Node.js
Manage contacts with Node.js
Ruby
Overview
Read messages and threads with Ruby
Send messages with Ruby
Manage contacts with Ruby
Python
Overview
Read messages and threads with Python
Send messages with Python
Manage folders and labels with Python
Manage events with Python
Manage contacts with Python
Kotlin/Java
Overview
Read messages and threads with Kotlin/Java
Send messages with Kotlin/Java
Manage folders and labels with Kotlin/Java
Manage contacts with Kotlin/Java
Developer resources
Platform
The Nylas platform
What is nyl.as?
API & provider rate limits
Data residency
Privacy mode
Field selection
Reporting abuse
Nylas static IP addresses
Nylas domain certificates
Supported attachment media types
Best practices
Security best practices
Managing grants
Handling expired grants
Improving email deliverability
Best practices for webhooks
Reducing payload size
Searching
Avoiding rate limits
Error monitoring & handling
Dealing with spam
About Nylas
Developing with Nylas
Using the Dashboard
Nylas MCP server
Customize Hosted Authentication branding
Using metadata
Using granular scopes
Nylas glossary
AI prompts for building with Nylas
Provider guides
Integrating providers
Google
Using Google accounts & data
Creating a Google auth app
Shared GCP App
Verification & security assessment
Working with delegated mailboxes & Groups
Setting up service accounts
Setting up Pub/Sub
Microsoft
Using Microsoft accounts & data
Creating an Azure auth app
Publisher verification guide
Authenticating Microsoft accounts
Configuring admin approval
Suggested Microsoft 365 settings
Shared Outlook folders
Troubleshooting Microsoft configuration
IMAP providers
Using IMAP accounts & data
Troubleshooting IMAP configuration
Authenticating Exchange on-prem accounts
Authenticating iCloud accounts
Authenticating Yahoo accounts
Zoom Meetings
Authenticating Zoom Meetings accounts
Troubleshooting Zoom Meetings
Using app passwords
Support & troubleshooting
How to get support
GDPR overview & inquiries
Usage calculation & billing
Troubleshooting
Get header content
Changed email account password
Message not received
Nylas link directs to spam
Immediate webhook notifications
Missing notifications for read messages
Changelogs
Home
…
Code with the Nylas SDKs
Using the Ruby SDK
Test webhooks locally with the Ruby SDK
Test webhooks locally with the Ruby SDK
Actions
🚀
More information coming soon!