feat(messages,drafts): support isPlaintext for messages.send and drafts.create

Author: AaronDDM

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- Support `isPlaintext` boolean for messages send and drafts create requests
+
 ### Changed
 - Upgraded node-fetch from v2 to v3 for better ESM support and compatibility with edge environments
 

examples/messages/examples/plaintext-send.ts

@@ -0,0 +1,40 @@
+// @ts-ignore dotenv is installed in examples package
+import * as dotenv from 'dotenv';
+// @ts-ignore import from built SDK when running examples
+import Nylas, { SendMessageRequest } from 'nylas';
+import * as path from 'path';
+import * as process from 'process';
+
+dotenv.config({ path: path.resolve(__dirname, '../../.env') });
+
+async function main(): Promise<void> {
+  const apiKey: string = process.env.NYLAS_API_KEY || '';
+  const grantId: string = process.env.NYLAS_GRANT_ID || '';
+  const toEmail: string | undefined = process.env.TEST_EMAIL;
+
+  if (!apiKey || !grantId || !toEmail) {
+    console.error('Please set NYLAS_API_KEY, NYLAS_GRANT_ID, and TEST_EMAIL in examples/.env');
+    process.exit(1);
+  }
+
+  const nylas = new Nylas({
+    apiKey,
+    apiUri: process.env.NYLAS_API_URI || 'https://api.us.nylas.com',
+  });
+
+  const requestBody: SendMessageRequest = {
+    to: [{ name: 'Plaintext Recipient', email: toEmail }],
+    subject: 'Plaintext message example',
+    body: 'This message is sent as plain text only.',
+    isPlaintext: true,
+  };
+
+  const res = await nylas.messages.send({ identifier: grantId, requestBody });
+  console.log('Sent message id:', res.data.id);
+}
+
+if (require.main === module) {
+  main();
+}
+
+

src/models/drafts.ts

@@ -71,6 +71,11 @@ export interface CreateDraftRequest {
    * An array of custom headers to add to the message.
    */
   customHeaders?: CustomHeader[];
+  /**
+   * When true, the message body is sent as plain text and the MIME data doesn't include the HTML version of the message.
+   * When false, the message body is sent as HTML. Defaults to false.
+   */
+  isPlaintext?: boolean;
 }
 
 /**
@@ -103,7 +108,10 @@ export interface Draft
 /**
  * Interface representing a request to update a draft.
  */
-export type UpdateDraftRequest = Partial<CreateDraftRequest> & {
+export type UpdateDraftRequest = Omit<
+  Partial<CreateDraftRequest>,
+  'isPlaintext'
+> & {
   /**
    * Return drafts that are unread.
    */

tests/resources/drafts.spec.ts

@@ -377,6 +377,61 @@ describe('Drafts', () => {
       expect(capturedRequest.method).toEqual('POST');
       expect(capturedRequest.path).toEqual('/v3/grants/id123/drafts');
     });
+
+    it('should include isPlaintext in JSON body when provided for create', async () => {
+      const jsonBody = {
+        to: [{ name: 'Test', email: 'test@example.com' }],
+        subject: 'Plain text draft',
+        body: 'Hello world',
+        isPlaintext: true,
+      };
+
+      await drafts.create({
+        identifier: 'id123',
+        requestBody: jsonBody,
+      });
+
+      const capturedRequest = apiClient.request.mock.calls[0][0];
+      expect(capturedRequest.method).toEqual('POST');
+      expect(capturedRequest.path).toEqual('/v3/grants/id123/drafts');
+      expect(capturedRequest.body).toEqual(jsonBody);
+    });
+
+    it('should include isPlaintext in multipart form message when provided for create', async () => {
+      const messageJson = {
+        to: [{ name: 'Test', email: 'test@example.com' }],
+        subject: 'Plain text draft',
+        body: 'Hello world',
+        isPlaintext: true,
+      };
+      const fileStream = createReadableStream('This is the text from file 1');
+      const file1: CreateAttachmentRequest = {
+        filename: 'file1.txt',
+        contentType: 'text/plain',
+        content: fileStream,
+        size: 3 * 1024 * 1024,
+      };
+
+      await drafts.create({
+        identifier: 'id123',
+        requestBody: {
+          ...messageJson,
+          attachments: [file1],
+        },
+      });
+
+      const capturedRequest = apiClient.request.mock.calls[0][0];
+      const formData = (
+        capturedRequest.form as any as MockedFormData
+      )._getAppendedData();
+      const parsed = JSON.parse(formData.message);
+      expect(parsed.to).toEqual(messageJson.to);
+      expect(parsed.subject).toEqual(messageJson.subject);
+      expect(parsed.body).toEqual(messageJson.body);
+      expect(parsed.is_plaintext).toBe(true);
+      expect(capturedRequest.method).toEqual('POST');
+      expect(capturedRequest.path).toEqual('/v3/grants/id123/drafts');
+    });
   });
 
   describe('update', () => {

tests/resources/messages.spec.ts

@@ -509,6 +509,61 @@ describe('Messages', () => {
       expect(capturedRequest.method).toEqual('POST');
       expect(capturedRequest.path).toEqual('/v3/grants/id123/messages/send');
     });
+
+    it('should include isPlaintext in JSON body when provided', async () => {
+      const jsonBody = {
+        to: [{ name: 'Test', email: 'test@example.com' }],
+        subject: 'Plain text email',
+        body: 'Hello world',
+        isPlaintext: true,
+      };
+
+      await messages.send({
+        identifier: 'id123',
+        requestBody: jsonBody,
+      });
+
+      const capturedRequest = apiClient.request.mock.calls[0][0];
+      expect(capturedRequest.method).toEqual('POST');
+      expect(capturedRequest.path).toEqual('/v3/grants/id123/messages/send');
+      expect(capturedRequest.body).toEqual(jsonBody);
+    });
+
+    it('should include isPlaintext in multipart form message when provided', async () => {
+      const messageJson = {
+        to: [{ name: 'Test', email: 'test@example.com' }],
+        subject: 'Plain text email',
+        body: 'Hello world',
+        isPlaintext: true,
+      };
+      const fileStream = createReadableStream('This is the text from file 1');
+      const file1: CreateAttachmentRequest = {
+        filename: 'file1.txt',
+        contentType: 'text/plain',
+        content: fileStream,
+        size: 3 * 1024 * 1024,
+      };
+
+      await messages.send({
+        identifier: 'id123',
+        requestBody: {
+          ...messageJson,
+          attachments: [file1],
+        },
+      });
+
+      const capturedRequest = apiClient.request.mock.calls[0][0];
+      const formData = (
+        capturedRequest.form as any as MockedFormData
+      )._getAppendedData();
+      const parsed = JSON.parse(formData.message);
+      expect(parsed.to).toEqual(messageJson.to);
+      expect(parsed.subject).toEqual(messageJson.subject);
+      expect(parsed.body).toEqual(messageJson.body);
+      expect(parsed.is_plaintext).toBe(true);
+      expect(capturedRequest.method).toEqual('POST');
+      expect(capturedRequest.path).toEqual('/v3/grants/id123/messages/send');
+    });
   });
 
   describe('scheduledMessages', () => {