Email scopes
This page lists the Email APIs and notification triggers available in Nylas API v3, and shows which scopes they require. These scopes allow Nylas to read and modify the end-user data on the provider, and trigger notifications. Add the scopes for each provider to your provider auth app.
The tables list both the most restrictive scope available that grants Nylas enough access, plus additional scopes that grant Nylas access but are less restrictive. If your app is already using one of these more permissive scopes for other purposes, you do not need to add the more restrictive scope.
All scopes must include the fully qualified URI path for the provider, for example https://www.googleapis.com/auth/... for Google, and https://graph.microsoft.com/... for Microsoft Graph. These have been omitted due to space constraints.
The ☑️ character appears near the most restrictive scope you can use to enable functionality on each provider. More permissive scopes that you can use instead appear under the minimum option.
Email API scopes
| Endpoint | Google Scopeshttps://www.googleapis.com/auth/... | Microsoft Scopeshttps://graph.microsoft.com/... |
|
GET |
|
|
|
GET |
|
|
|
PUT DELETE |
|
|
|
GET |
|
|
|
POST |
|
|
|
POST |
|
|
|
POST |
|
|
|
POST |
|
|
|
POST |
|
|
|
GET |
|
|
|
POST |
|
|
|
GET |
|
|
|
GET |
No scopes required because scheduled messages are stored with Nylas. | |
Email API scopes for Yahoo OAuth
If you use Yahoo OAuth authentication to connect to Yahoo users' email inboxes, include the following scopes in your Yahoo provider auth app.
All email-related notifications require the Yahoo email and mail-r scopes.
| Endpoint | Yahoo scopes |
|---|---|
GET /messages
GET /messages/{message_id}
GET /drafts
GET /drafts/{draft_id}
GET /folders
GET /folders/{folder_id}
GET /attachments/ |
email
mail-r
|
PUT /messages/
DELETE /messages/
POST /drafts
PUT /drafts/{draft_id}
DELETE /drafts/{draft_id}
POST /messages/smart-compose
POST /messages/{message_id}/smart-compose
POST /messages/send
POST /messages/send (using draft)
POST /folders
PUT /folders/{folder_id}
DELETE /folders/{folder_id}
|
email
mail-r
mail-w
|
Email notification scopes
| Notification trigger | Google Scopeshttps://www.googleapis.com/auth/... | Microsoft Scopeshttps://graph.microsoft.com/... |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|