@mailhooks/sdk 1.0.4 → 1.0.5

package/README.md

@@ -62,6 +62,7 @@ const emails = await mailhooks.emails.list({
     subject: 'Important',
     startDate: '2024-01-01',
     endDate: '2024-12-31',
+    read: false, // Filter by read status
   },
   sort: {
     field: 'createdAt',
@@ -73,7 +74,11 @@ const emails = await mailhooks.emails.list({
 #### Get Email
 
 ```typescript
+// Get email without marking as read
 const email = await mailhooks.emails.getEmail('email-id');
+
+// Get email and mark it as read in one call
+const readEmail = await mailhooks.emails.getEmail('email-id', true);
 ```
 
 #### Get Email Content
@@ -99,14 +104,29 @@ const attachment = await mailhooks.emails.downloadAttachment('email-id', 'attach
 // attachment.contentType contains the MIME type
 ```
 
+#### Mark Email as Read/Unread
+
+```typescript
+// Mark email as read
+const readEmail = await mailhooks.emails.markAsRead('email-id');
+console.log(readEmail.read); // true
+
+// Mark email as unread
+const unreadEmail = await mailhooks.emails.markAsUnread('email-id');
+console.log(unreadEmail.read); // false
+```
+
 #### Wait for Email
 
 Wait for an email that matches specific filters. Useful for testing and automation.
 
 ```typescript
-// Basic usage - wait for email from specific sender
+// Basic usage - wait for unread email from specific sender
 const email = await mailhooks.emails.waitFor({
-  filter: { from: 'noreply@example.com' },
+  filter: { 
+    from: 'noreply@example.com',
+    read: false // Only wait for unread emails
+  },
   timeout: 30000, // 30 seconds
   pollInterval: 2000, // Check every 2 seconds
 });
@@ -117,6 +137,7 @@ const email = await mailhooks.emails.waitFor({
     from: 'noreply@example.com',
     to: 'test@yourdomain.com',
     subject: 'Order Confirmation',
+    read: false, // Only unread emails
   },
   lookbackWindow: 10000, // Only consider emails from last 10 seconds
   initialDelay: 5000,    // Wait 5 seconds before first check
@@ -127,7 +148,7 @@ const email = await mailhooks.emails.waitFor({
 ```
 
 **Options:**
-- `filter`: Same filters as `list()` method (from, to, subject, startDate, endDate)
+- `filter`: Same filters as `list()` method (from, to, subject, startDate, endDate, read)
 - `lookbackWindow`: How far back to look for emails on first check (default: 10000ms)
 - `initialDelay`: Delay before starting to poll (default: 0ms)
 - `timeout`: Maximum time to wait before throwing error (default: 30000ms)
@@ -150,6 +171,7 @@ interface Email {
   from: string;
   to: string[];
   subject: string;
+  read: boolean;
   createdAt: Date;
   attachments: Attachment[];
 }

package/dist/client.d.ts

@@ -7,6 +7,7 @@ export declare class MailhooksClient {
     protected get<T>(path: string, params?: Record<string, any>): Promise<T>;
     protected post<T>(path: string, data?: any): Promise<T>;
     protected put<T>(path: string, data?: any): Promise<T>;
+    protected patch<T>(path: string, data?: any): Promise<T>;
     protected delete<T>(path: string): Promise<T>;
     protected downloadFile(path: string): Promise<ArrayBuffer>;
     protected getAxiosInstance(): AxiosInstance;

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,qBAAa,eAAe;IAC1B,OAAO,CAAC,IAAI,CAAgB;gBAEhB,MAAM,EAAE,eAAe;IAkBnC,OAAO,CAAC,UAAU;cAkBF,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;cAK9D,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;cAK7C,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;cAK5C,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;cAKnC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOhE,SAAS,CAAC,gBAAgB,IAAI,aAAa;CAG5C"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,aAAa,EAAiB,MAAM,OAAO,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE1C,qBAAa,eAAe;IAC1B,OAAO,CAAC,IAAI,CAAgB;gBAEhB,MAAM,EAAE,eAAe;IAkBnC,OAAO,CAAC,UAAU;cAkBF,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;cAK9D,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;cAK7C,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;cAK5C,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC;cAK9C,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;cAKnC,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAOhE,SAAS,CAAC,gBAAgB,IAAI,aAAa;CAG5C"}

package/dist/client.js

@@ -53,6 +53,10 @@ class MailhooksClient {
         const response = await this.http.put(path, data);
         return response.data;
     }
+    async patch(path, data) {
+        const response = await this.http.patch(path, data);
+        return response.data;
+    }
     async delete(path) {
         const response = await this.http.delete(path);
         return response.data;

package/dist/resources/emails.d.ts

@@ -7,8 +7,10 @@ export declare class EmailsResource extends MailhooksClient {
     list(params?: EmailListParams): Promise<EmailsResponse>;
     /**
      * Get a specific email by ID
+     * @param emailId - The ID of the email to retrieve
+     * @param markAsRead - Optional: Mark the email as read when fetching (default: false)
      */
-    getEmail(emailId: string): Promise<Email>;
+    getEmail(emailId: string, markAsRead?: boolean): Promise<Email>;
     /**
      * Get the HTML and text content of an email
      */
@@ -21,6 +23,14 @@ export declare class EmailsResource extends MailhooksClient {
      * Download a specific attachment from an email
      */
     downloadAttachment(emailId: string, attachmentId: string): Promise<DownloadResponse>;
+    /**
+     * Mark an email as read
+     */
+    markAsRead(emailId: string): Promise<Email>;
+    /**
+     * Mark an email as unread
+     */
+    markAsUnread(emailId: string): Promise<Email>;
     /**
      * Wait for an email that matches the given filters
      *

package/dist/resources/emails.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"emails.d.ts","sourceRoot":"","sources":["../../src/resources/emails.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EACL,KAAK,EACL,YAAY,EACZ,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,cAAc,EACf,MAAM,UAAU,CAAC;AAElB,qBAAa,cAAe,SAAQ,eAAe;IACjD;;OAEG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IAyB7D;;OAEG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAI/C;;OAEG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIxD;;OAEG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAS7D;;OAEG;IACG,kBAAkB,CACtB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,gBAAgB,CAAC;IAqB5B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,OAAO,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,KAAK,CAAC;CA8F5D"}
+{"version":3,"file":"emails.d.ts","sourceRoot":"","sources":["../../src/resources/emails.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EACL,KAAK,EACL,YAAY,EACZ,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,cAAc,EACf,MAAM,UAAU,CAAC;AAElB,qBAAa,cAAe,SAAQ,eAAe;IACjD;;OAEG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC;IA0B7D;;;;OAIG;IACG,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,GAAE,OAAe,GAAG,OAAO,CAAC,KAAK,CAAC;IAK5E;;OAEG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAIxD;;OAEG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAS7D;;OAEG;IACG,kBAAkB,CACtB,OAAO,EAAE,MAAM,EACf,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,gBAAgB,CAAC;IAqB5B;;OAEG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAIjD;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAInD;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,OAAO,CAAC,OAAO,GAAE,cAAmB,GAAG,OAAO,CAAC,KAAK,CAAC;CA8F5D"}

package/dist/resources/emails.js

@@ -24,6 +24,8 @@ class EmailsResource extends client_1.MailhooksClient {
                 queryParams['filter.createdAfter'] = params.filter.startDate;
             if (params.filter.endDate)
                 queryParams['filter.createdBefore'] = params.filter.endDate;
+            if (params.filter.read !== undefined)
+                queryParams['filter.read'] = String(params.filter.read);
         }
         // Handle sort params
         if (params?.sort) {
@@ -36,9 +38,12 @@ class EmailsResource extends client_1.MailhooksClient {
     }
     /**
      * Get a specific email by ID
+     * @param emailId - The ID of the email to retrieve
+     * @param markAsRead - Optional: Mark the email as read when fetching (default: false)
      */
-    async getEmail(emailId) {
-        return super.get(`/v1/emails/${emailId}`);
+    async getEmail(emailId, markAsRead = false) {
+        const params = markAsRead ? { markAsRead: 'true' } : undefined;
+        return super.get(`/v1/emails/${emailId}`, params);
     }
     /**
      * Get the HTML and text content of an email
@@ -75,6 +80,18 @@ class EmailsResource extends client_1.MailhooksClient {
             contentType: response.headers['content-type'],
         };
     }
+    /**
+     * Mark an email as read
+     */
+    async markAsRead(emailId) {
+        return super.patch(`/v1/emails/${emailId}/read`);
+    }
+    /**
+     * Mark an email as unread
+     */
+    async markAsUnread(emailId) {
+        return super.patch(`/v1/emails/${emailId}/unread`);
+    }
     /**
      * Wait for an email that matches the given filters
      *

package/dist/types.d.ts

@@ -9,6 +9,7 @@ export interface Email {
     from: string;
     to: string[];
     subject: string;
+    read: boolean;
     createdAt: Date;
     attachments: Attachment[];
 }
@@ -33,6 +34,7 @@ export interface EmailFilter {
     subject?: string;
     startDate?: string;
     endDate?: string;
+    read?: boolean;
 }
 export interface EmailSort {
     field?: 'createdAt' | 'from' | 'subject';

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,EAAE,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACxD,IAAI,EAAE,KAAK,EAAE,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;IACzC,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,EAAE,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,OAAO,CAAC;IACd,SAAS,EAAE,IAAI,CAAC;IAChB,WAAW,EAAE,UAAU,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAkB;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACxD,IAAI,EAAE,KAAK,EAAE,CAAC;CACf;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,MAAM,WAAW,SAAS;IACxB,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS,CAAC;IACzC,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mailhooks/sdk",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "TypeScript SDK for Mailhooks API",
   "publishConfig": {
     "access": "public"