Only show these results:

Mailbox Component

Use the Nylas Mailbox Component to connect to any inbox and provide a custom front end for your applications.

Without needing to write a single line of code, the Mailbox Component comes with:

  • To, from, subject display
  • Message previews
  • Thread display and expansion on click
  • Ability to star threads
  • Ability to mark threads as read or unread
  • Thread selection, including selecting all threads
  • Built-in pagination
  • Customization options
Nylas Mailbox Component opening and closing. Also shows the user selecting and starring messages.

Quickstart

  1. Create a Mailbox component in your Nylas Dashboard.
  2. Add it to your application.
    <head>
<!-- Import the script from CDN -->
<script src="https://unpkg.com/@nylas/components-mailbox"></script>
</head>
<body>
<!-- Place the component on the page -->
<nylas-mailbox id="<PASTE_YOUR_COMPONENT_ID>"></nylas-mailbox>
</body>

That’s It! Your Mailbox Component is ready to use!

Quickstart Sandbox

Prerequisites

  • Either an existing Nylas application or sign up using our Quickstart.
  • If using an existing application, make sure you have the minium required scopes.
    • Agenda - calendar
    • Composer - email.modify, email.send,and contacts
    • Contact List - contacts
    • Email - email.modify,email.folders_and_labels, and contacts
    • Messages - email.read_only and contacts
  • An application to add the Component to. You can fork one of the many CodeSandboxes in the documentation.

Mailbox Installation Options

You can install the Mailbox Component 2 ways:

npm Package

Mailbox on npm

  1. Run npm i @nylas/components-mailbox or yarn add @nylas/components-mailbox
  2. Then import and render the component.
    // Import the web component
import '@nylas/components-mailbox`;

// In render method
<nylas-mailbox></nylas-mailbox>

Script Tag

Use the CDN script tag, https://unpkg.com/@nylas/components-mailbox.

    <head>
<!-- Import the script from CDN -->
<script src="https://unpkg.com/@nylas/components-mailbox"></script>
</head>
<body>
<!-- Place the component on the page -->
<nylas-mailbox></nylas-mailbox>
</body>

Ways to Use the Mailbox Component

Use the Mailbox Component with Nylas Data

You'll learn how to use your Nylas accounts with the Mailbox Component.

Create the Mailbox Component

  1. Log in to your Nylas dashboard.
  2. Click Components > Mailbox
  3. Name your Component and select the account. To quickly start testing your Component select Enable for a single account.
    1. To learn how to enable components for multiple accounts see Authorizing Components
  4. Use an existing access token or generate a new one.
  5. Enter the domain the component will run on. Without the domain, the component will not run.
    1. To run on localhost, enter an asterisk. *. Remember to change this before going to production.
  6. Save your new component.
  7. On the Edit page, you can configure your component behavior and appearance.

Generate an Access Token

Generating a new access token will not replace your existing access token; it will create a second access token with the same scopes as the previous token. You can revoke access tokens at any time.

Add the Component To Your Application

  1. On the Edit page, there are instructions for installing the new component.
    1. We recommend that you filter or query your threads. Mailbox will display threads located in inbox and trash.
    2. Search will accept any keyword and filter accepts any query parameter listed for Threads.
  2. If you haven't installed the Mailbox Component already, open a terminal and run npm i @nylas/components-mailbox.
  3. Then add your Nylas component. Copy and paste your component code into your application.
    <nylas-mailbox id="your-component-id" ></nylas-mailbox>
  4. You should refresh your application if needed. Any configuration options set on the editing page will apply to your Component.

Use the Mailbox Component with External Data

You can pass your own thread data for Mailbox to display. The threads format and type need to match the Threads object.

External Data Sandbox

Authorizing Components

With components, you can authorize them to work with a single account or multiple accounts.

Enable for a Single Account

A single account is a way to get started quickly. If you use this method in production, you'll have to authenticate each account from the dashboard one by one.

Enable components single account

Enable for All Accounts

To enable all accounts, you'll need to pass in a user's access token as a property of the component. One way to achieve this is to create a login screen, capture the access token and pass it into the component. You can pass in access_tokens directly in the Component.

<nylas-agenda id="COMPONENT-ID" access_token="USER-ACCESS-TOKEN"/>

Make sure to keep access_tokens hidden and never expose them online.

Enable Components for all accounts

Dashboard Preview

Dashboard previews do not work when enabling for all accounts.

Customization

Nylas Components are flexible and can be customized for your needs.

Mailbox Properties

Name Type Description Default
show_thread_checkbox boolean Choose whether or not to display selection checkboxes beside each thread. True
items_per_page number The number of threads to show per page. 13
show_star boolean Choose whether or not stars appear on each thread. false
header string Change what title is displayed at the top of mailbox. Null or not displayed
unread_status string read, unread, or default. If set to default, uses the read status attached to the thread/message. Otherwise sets all threads and messages in the mailbox to be read and unread for read and unread respectively. default
keyword_to_search string Return threads that match any string None
query_string string Search for messages using query strings and display those in the component. "in=trash from=kat@spacetech.com" Allowed paramters. None
show_star boolean Show stars next to messages so the user can start and unstar messages None

Mailbox Event Listeners

Use event listeners to customize the mailbox.

Name Description
manifestLoaded This event is dispatched on load when the manifest is loaded. The handler is passed the manifest argument.
threadClicked When a thread is opened or closed. The handler is passed the event and selectedThreads arguments.
onChangeSelectedReadStatus When selected emails or threads are marked as read or unread. The handler is passed the event and selectedThreads arguments.
onDeleteSelected When emails or threads are deleted. If a single email or thread is deleted, it is captured in thread. If multiple emails or threads are deleted, it is captured in selectedThreads. The handler is passed the event and selectedThreads arguments.
onStarSelected When selected emails or threads are starred or unstarred. The handler is passed the event and selectedThreads arguments.
refreshClicked When the refresh button in the mailbox is clicked. The handler is passed the event argument.
onSelectOneClicked When a single email or thread is selected by clicking on the checkbox. The handler is passed the event and thread arguments
onSelectAllClicked When select all checkbox is checked or unchecked. The handler is passed the event and selectedThreads arguments.

Mailbox Event Listeners Sandbox

Allowed Domains

You can restrict the domains that your Component works on. Use glob patterns to enable or disable domains.

Some examples of glob patterns:

  • nylas.com will only match nylas.com
  • subdomain.nylas.com will match subdomain.nylas.com
  • *subdomain.nylas.com will match subdomain.nylas.com and sub.sub.subdomain.nylas.com
  • * will match any domain

Domain restriction only applies to the domain name. URL paths (/sub-path) or protocols (HTTPS) can not be restricted.

How Properties Are Handled

Nylas Components follow an order of operations to decide if the dashboard or code takes precedence.

  1. If the property is passed directly to the Component, use that first.
  2. If the property is not passed directly in the Component, use the dashboard settings.
  3. If there are no properties set in the Component or the dashboard, use the Component defaults.

What's Next?