CHANGELOG.md

Changelog

[6.7.1]

• Fix large attachment handling with string keys and custom content_ids

[6.7.0]

• Added access to response headers

[6.6.0]

• Added support for single_level query parameter in Folders API for Microsoft accounts
• Added support for include_hidden_folders query parameter in folders list endpoint for Microsoft accounts to control whether hidden folders are included in the response
• Added support for passing in string contents for multipart and base64 (<3MB) attachments (#528)
• Fixed HTTParty encoding compatibility issue with multipart requests (#528)

6.5.0 / 2025-06-13

• Replaced rest-client dependency with httparty for improved maintainability and security
  • rest-client is no longer actively maintained and has known security vulnerabilities
  • httparty is actively maintained and provides better performance
  • All existing functionality remains backwards compatible - no customer code changes required
  • Removed workaround for rest-client cookie jar threading bug
• Added support for new fields query parameter values in Messages API:
  • include_tracking_options: Returns messages and their tracking settings
  • raw_mime: Returns the grant_id, object, id, and raw_mime fields only
• Added support for tracking_options field in message responses containing:
  • opens: Boolean indicating if message open tracking is enabled
  • thread_replies: Boolean indicating if thread replied tracking is enabled
  • links: Boolean indicating if link clicked tracking is enabled
  • label: String label describing the message tracking purpose
• Added support for raw_mime field in message responses containing Base64url-encoded message data
• Added MessageFields module with constants for all valid field values to improve developer experience
• Fixed multipart email sending bug where large attachments would fail due to multipart flag key mismatch (#525)
  • FileUtils.handle_message_payload transforms keys to symbols (:multipart)
  • HttpClient.build_request was only checking for string keys ("multipart")
  • Now checks for both string and symbol keys to maintain full backwards compatibility
  • Prevents encoding errors when sending emails with attachments larger than 3MB

6.4.0 / 2025-04-30

• Added support for Notetaker APIs
• Added support for Notetaker via the calendar and event APIs
• Added MESSAGE_BOUNCE_DETECTED to the webhook triggers
• Fixed issue to raise an explicit exception when the response lacks a JSON body (#520)

6.3.0 / 2025-03-03

• Removed file_path from File object to match the Send API schema
• Added events import function to the RubySDK
• Added response headers to Ruby SDK

6.2.3 / 2025-01-23

• Fixed issue where errors were not properly thrown due to an instance type of String instead of Hash

6.2.2 / 2024-12-02

• Added support for private Scheduling configuration.
• Added ability to add optional content_id to support inline image on send.
• Added custom filename support for large attachments.
• Adjusted the gendoc to show that the provider_error is a Hash.

6.2.1 / 2024-11-12

• Added support for scheduler APIs
• Added query_params field to Folders & Threads find
• Added custom filename support for attachments

6.2.0 / 2024-09-24

• Added query support for folders
• Added dependency on ostruct gem
• Enable SDK to reattach large files to messages on retry
• Downgraded rest-client to 2.0 for better compatibility

6.1.1 / 2024-08-20

• Fixed sending attachments less than 3MB

6.1.0 / 2024-06-25

• Added query support for messages
• Added support for clean messages
• Added support for getting access token info
• Added new webhook triggers

6.0.3 / 2024-03-05

• Improved message sending and draft create/update performance
• Change default timeout to match API (90 seconds)
• Fixed error when invoking Auth.detect_provider

6.0.2 / 2024-02-27

• Fixed the HTTP operation of updating grants
• Fixed endpoint URL of rotating webhooks

6.0.1 / 2024-02-12

• Fixed a bug during OAuth URL building
• Fixed a bug where the next_cursor field was omitted for list responses

6.0.0 / 2024-02-05

• BREAKING CHANGE: Ruby SDK v6 supports the Nylas API v3 exclusively, dropping support for any endpoints that are not available in v3.
• BREAKING CHANGE: Officially support minimum Ruby v3
• BREAKING CHANGE: Removed all models and typing from the SDK
• REMOVED: Local Webhook development support is removed due to incompatibility
• Rewritten the majority of SDK to be more modular and efficient
• Created error classes for the different API errors as well as SDK-specific errors
• Added a configurable timeout for outgoing calls to the API

5.17.0 / 2022-04-04

• Add support for verifying webhook signatures
• Add event.updated_at
• Allow native authentication to return the full response like the exchange_code_for_token

5.16.0 / 2022-03-14

• Add missing provider_id attribute to Label
• Add organizer_email and organizer_name to Event
• Add missing job status webhook triggers
• Fix MESSAGE_LINK_CLICKED trigger

5.15.0 / 2022-02-02

• Add local webhook testing support
• Add tzinfo, faye-websocket, eventmachine as runtime dependencies

5.14.0 / 2022-12-16

• Added support for rate limit errors
• Added disable_provider_selection option for building auth URL
• Improved performance by skipping creating instance of StringIO before parsing JSON

5.13.0 / 2022-10-21

• Add timezone fields to the When class
• Adds visibility attribute to Event class
• Add support for calendar colors (for Microsoft calendars)

5.12.1 / 2022-08-12

• Add support for getting ids and count for collections not supported by the API
• Fix Ruby 3.x compatibility for expanding keyword arguments

5.12.0 / 2022-07-29

• Add missing hosted authentication parameters
• Add reply_to_message_id field in Messages
• Fix calendar availability failing when round_robin is nil

5.11.0 / 2022-07-08

• Add support for event reminders
• Add metadata field to JobStatus

5.10.0 / 2022-05-10

• Support collective and group events
• Fix ModelNotFilterableError when querying for accounts with metadata

5.9.2 / 2022-05-04

• Fix calendar availability not serializing FreeBusy and OpenHours properly
• Fix Authentication demo app using deprecated Google scopes

5.9.1 / 2022-04-20

• Add missing phone_number field in Participant
• Fix NoMethodError when calling NewMessage#send!

5.9.0 / 2022-04-07

• Add Outbox support
• Add new authentication_type field in Account
• Add support for basic authentication
• Enable Nylas API v2.5 support

5.8.0 / 2022-03-18

• Improved support for Webhook objects
• Support calendars for availability methods
• Fix interval_minutes keyword for availability methods

5.7.0 / 2022-01-21

• Add job status support
• Add Event to ICS support
• Add support for getting access token information
• Improved support for Application Details
• Enable ability to delete Account objects
• Fix saving and deleting Folder objects

5.6.1 / 2021-12-13

• Enabled support for adding metadata to a NewMessage/Draft
• Fix bug where updating an Event results in an API error

5.6.0 / 2021-11-22

• Add support for event notifications
• Add more Scheduler support
• Add metadata support for Calendar, Message and Account
• Modify exchange_code_for_token to allow returning a full body

5.5.0 / 2021-10-28

• Add Component CRUD Support
• Add Scheduler support
• Add support for calendar availability
• Add support for File delete operation
• Fix issue where file_ids get reset to empty

5.4.1 / 2021-09-27

• Fix draft send method to send existing draft when tracking is enabled

5.4.0 / 2021-09-23

• Add support for Event Conferencing
• Fix update draft failing if version is not explicitly set
• Fix draft .send logic

5.3.0 / 2021-08-18

• Add support for Neural API
• Fix issue where Delta did not have a header attribute for expanded headers
• Fix ArgumentError when calling Nylas::API#send! due to missing double splat (**)
• Fix issue where server errors are not reported if HTML is returned
• Fix issue where expanded Thread objects were not returning messages

5.2.0 / 2021-06-07

• Add support for Room Resource
• Fix issue where "302 Redirect" response codes were treated as errors
• Fix issue where api value was overriden when calling message.expanded

5.1.0 / 2021-06-07

• Add support for read only attributes
• Add save_all_attributes and update_all_attributes methods to support nullifying attributes.
• Add support new Event metadata feature
• Fix attributes assignment for Delta
• Fix issue where files couldn't be attached to drafts
• Fix exception raise when content-type is not JSON
• Fix issue where draft version wouldn't update after update or save

5.0.0 / 2021-05-07

• Send Nylas-API-Version header to API with latest supported version.
• Fix issue sending message using raw mime type.
• Support for messages.expanded.find(id) to return expanded message.
• Add support for hosted authentication
• Fix bug to not send id, object and account_id on events update call

4.6.7 / 2021-04-22

• Support for Ruby 3.
• Add support for /free-busy endpoint
• Fix issue where download a file fetch via find failed,

4.6.6 / 2021-04-06

• Add support for notify_participants when creating events
• Add provider attribute to account

4.6.5 / 2021-02-22

• Add content_disposition field to File
• Fix thread-safety issue in HTTP::CookieJar loading

4.6.4 / 2021-02-03

• fix failing http_client spec after merging main
• Skip parsing response if content is not JSON
• Add missing http status codes / errors.
• Add reply_to to NewMessage
• Add message tracking to drafts.
• Truncate the returned filename so it's less than 256 characters and compatible with rb_sysopen.
• Bump required rest client dep to >= 2.0, remove travis ci tests for rest client 1, ruby v2.3
• Use to_json helper instead of JSON.dump.

4.6.3 / 2020-12-18

• Remove folder on message.save for updates
• Fix JSON parsing behavior
• Fix rubocop warnings for http_client and spec
• No longer rescue json parse errors, use Yajl instead of JSON for parsing responses (due to unicode issue).
• Add specs for changes to message.save
• Store folder id in folder_id and remove folder if present before saving.
• Adding secondary_address field to physical address model

4.6.2 / 2020-09-08

• Add support to move message and thread between folder.
• Handle new attributes added to API gracefully
• Add is_primary and other new Calendar attributes

4.6.1 / 2020-01-06

• Fix a bug with when blocks when creating events
• Add support for the Event.ical_uid field

4.6.0 / 2019-09-25

• Add support for /contacts/groups endpoint.
• Fix issue when calling .save on message (#233)
• Add support for Rails 6.
• Fix issue for updating message with sending label_ids (#231)
• Support for when in Nylas::Event for more attributes.
• Add internal transfer api to support initialize related objects.
• Fix encoding issues when downloading attachments.

4.5.0 / 2019-04-15

• Add support for source attribute in Contact model

4.4.0 / 2019-04-05

• Add support for /ip_addresses endpoint
• Add optional argument for Model#to_json
• Reintroduce support for Ruby 2.3
• Add Rails 4 bundler support to setup script
• Specify gemfiles called in test script

4.3.0 / 2019-03-18

• Drop support for Ruby 2.2 and 2.3: they have reached end-of-life
• Add support for Ruby 2.5 and 2.6
• Add scopes argument to Nylas::API#authenticate for selective sync
• Add Account#revoke_all
• Add X-Nylas-Client-Id header for HTTP requests

4.2.4 / 2018-08-07

• Enables silent addition of fields to API without impact to SDK
• Fixes api attribute breakage on enumeration (#188)

4.0.0 / 2018-01-??

• Drop support for ruby 2.0 and below
• Add support for v2 of the Contacts API
• Switch to an ActiveModel/ActiveQuery compliant interface for interacting with objects and APIs

3.2.0 / 2017-11-16

• Add support for Ruby 2.4+
• Add support for Rails 4+
• Filters now work correctly for all models
• .each now pages requests
• Numerous other bug fixes

3.1.1 / 2017-06-23

• Fix deleting event request (#101)

3.1.0 / 2017-05-10

• Adds support for message tracking (https://github.com/cberkom)

3.0.0 / 2016-11-04

• Removes interpret_http_status to be included in interpret_response
• Improve error handling
• Add native authentication example code
• Add webhooks example code
• Removes experimental JRuby support

full changelog

2.0.1 / 2016-02-12

• Fix folders and labels updates for threads and messages
• Revert pull request #71

full changelog

2.0.0 / 2016-02-05

• Remove get_cursor method that calls deprecated generate_cursor endpoint
• Modify delta_stream method to remove built-in EventMachine.run block and allow for multiple streams. delta_stream must now be called from inside an EventMachine.run block
• url_for_authentication now accepts a :state parameter (see https://nylas.com/docs#server_side_explicit_flow for more details)

full changelog

1.3.0 / 2015-12-07

• Deprecate the tags API
• Remove the archive!/unarchive! methods
• Expose starred, unread, has_attachments in Nylas::Thread

full changelog

1.2.0 / 2015-11-19

• Add Messages#files? Issue #40
• Return an external Enumerator when no block given. Issue #42 (Steven Harman)
• Expose folders in the Delta Stream API.
• Add Inbox::Error base class for all errors. (Steven Harman)
• Expose sync_state on the /account API. (Steven Harman)
• Return Enumerator for #deltas when no block given
• Ruby < 1.9.3 no longer supported
• Add travis support for Mac OS X

full changelog

1.1.0 / 2015-09-22

• Message#expanded returns an expanded version of a message
• Expose the server_error field when failing to send messages
• minor bug fixes
• various test cleanups (Steven Harman)

full changelog