@internxt/sdk 1.15.10 → 1.15.12

package/dist/mail/api.d.ts

@@ -1,6 +1,6 @@
 import { ApiSecurity, ApiUrl, AppDetails } from '../shared';
 import { EncryptedKeystore, KeystoreType, HybridEncryptedEmail, PwdProtectedEmail, RecipientWithPublicKey, EmailPublicParameters } from 'internxt-crypto';
-import { MailboxResponse, EmailListResponse, EmailResponse, EmailCreatedResponse, SendEmailRequest, DraftEmailRequest, UpdateEmailRequest, ListEmailsQuery } from './types';
+import { MailboxResponse, EmailListResponse, EmailResponse, EmailCreatedResponse, SendEmailRequest, DraftEmailRequest, UpdateEmailRequest, ListEmailsQuery, EmailDomainsResponse, SetupMailAccountPayload, SearchFiltersQuery, MailAccountKeysResponse } from './types';
 export declare class MailApi {
     private readonly client;
     private readonly appDetails;
@@ -46,13 +46,78 @@ export declare class MailApi {
      * @returns Server response
      */
     sendE2EPasswordProtectedEmail(email: PwdProtectedEmail, params: EmailPublicParameters): Promise<void>;
+    search(filters: SearchFiltersQuery): Promise<EmailListResponse>;
+    /**
+     * Gets the mailboxes of the user
+     *
+     * @returns The mailboxes of the user - `MailboxResponse[]`
+     */
     getMailboxes(): Promise<MailboxResponse[]>;
+    /**
+     * Lists emails of the user
+     *
+     * @param query - The query to filter emails (e.g. mailbox, limit, etc.)
+     * @returns The list of emails - `EmailListResponse`
+     */
     listEmails(query?: ListEmailsQuery): Promise<EmailListResponse>;
+    /**
+     * Gets the email with the corresponding id
+     *
+     * @param id - The id of the email
+     * @returns The email with the corresponding id - `EmailResponse`
+     */
     getEmail(id: string): Promise<EmailResponse>;
+    /**
+     * Deletes the email with the corresponding id
+     *
+     * @param id - The id of the email to delete
+     * @returns A promise that resolves when the email is deleted
+     */
     deleteEmail(id: string): Promise<void>;
+    /**
+     * Updates the email with the corresponding id
+     *
+     * @param id - The id of the email to update
+     * @param body - The new body of the email
+     * @returns A promise that resolves when the email is updated
+     */
     updateEmail(id: string, body: UpdateEmailRequest): Promise<void>;
+    /**
+     * Sends an email to the specified recipients
+     *
+     * @param body - The body of the email to send
+     * @returns The created email
+     */
     sendEmail(body: SendEmailRequest): Promise<EmailCreatedResponse>;
+    /**
+     * Saves a draft email
+     *
+     * @param body - The body of the draft email to save
+     * @returns The created email - `EmailCreatedResponse`
+     */
     saveDraft(body: DraftEmailRequest): Promise<EmailCreatedResponse>;
+    /**
+     * Returns the list of active domains for the email gateway
+     *
+     * @returns The list of active domains - `ActiveDomainsResponse`
+     */
+    getActiveDomains(): Promise<EmailDomainsResponse>;
+    /**
+     * Sets up a mail account for the user
+     *
+     * @param payload - Set of details for mail account setup
+     * @returns A promise that resolves with the created mail account address
+     */
+    setupMailAccount(payload: SetupMailAccountPayload): Promise<{
+        address: string;
+    }>;
+    /**
+     * Gets the mail account keys for the given address
+     *
+     * @param address - The mail address whose keys should be retrieved
+     * @returns The public, encrypted private and recovery keys plus the salt
+     */
+    getMailAccountKeys(address: string): Promise<MailAccountKeysResponse>;
     /**
      * Returns the needed headers for the module requests
      * @private

package/dist/mail/api.js

@@ -59,7 +59,7 @@ var MailApi = /** @class */ (function () {
     MailApi.prototype.uploadKeystore = function (keystore) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.client.post("".concat(this.apiUrl, "/keystore"), { encryptedKeystore: keystore }, this.headers())];
+                return [2 /*return*/, this.client.post('/keystore', { encryptedKeystore: keystore }, this.headers())];
             });
         });
     };
@@ -73,7 +73,7 @@ var MailApi = /** @class */ (function () {
     MailApi.prototype.downloadKeystore = function (userEmail, keystoreType) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.client.getWithParams("".concat(this.apiUrl, "/user/keystore"), { userEmail: userEmail, keystoreType: keystoreType }, this.headers())];
+                return [2 /*return*/, this.client.getWithParams('/user/keystore', { userEmail: userEmail, keystoreType: keystoreType }, this.headers())];
             });
         });
     };
@@ -89,7 +89,7 @@ var MailApi = /** @class */ (function () {
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.client.post("".concat(this.apiUrl, "/users/public-keys"), { emails: emails }, this.headers())];
+                    case 0: return [4 /*yield*/, this.client.post('/users/public-keys', { emails: emails }, this.headers())];
                     case 1:
                         response = _a.sent();
                         return [4 /*yield*/, Promise.all(response.map(function (item) { return __awaiter(_this, void 0, void 0, function () {
@@ -116,7 +116,7 @@ var MailApi = /** @class */ (function () {
     MailApi.prototype.sendE2EEmails = function (emails, params) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.client.post("".concat(this.apiUrl, "/emails"), { emails: emails, params: params }, this.headers())];
+                return [2 /*return*/, this.client.post('/emails', { emails: emails, params: params }, this.headers())];
             });
         });
     };
@@ -130,56 +130,143 @@ var MailApi = /** @class */ (function () {
     MailApi.prototype.sendE2EPasswordProtectedEmail = function (email, params) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.client.post("".concat(this.apiUrl, "/emails"), { email: email, params: params }, this.headers())];
+                return [2 /*return*/, this.client.post('/emails', { email: email, params: params }, this.headers())];
             });
         });
     };
+    MailApi.prototype.search = function (filters) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.client.post('/email/search', filters, this.headers())];
+            });
+        });
+    };
+    /**
+     * Gets the mailboxes of the user
+     *
+     * @returns The mailboxes of the user - `MailboxResponse[]`
+     */
     MailApi.prototype.getMailboxes = function () {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.client.get("".concat(this.apiUrl, "/email/mailboxes"), this.headers())];
+                return [2 /*return*/, this.client.get('/email/mailboxes', this.headers())];
             });
         });
     };
+    /**
+     * Lists emails of the user
+     *
+     * @param query - The query to filter emails (e.g. mailbox, limit, etc.)
+     * @returns The list of emails - `EmailListResponse`
+     */
     MailApi.prototype.listEmails = function (query) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.client.getWithParams("".concat(this.apiUrl, "/email"), query !== null && query !== void 0 ? query : {}, this.headers())];
+                return [2 /*return*/, this.client.getWithParams('/email', query !== null && query !== void 0 ? query : {}, this.headers())];
             });
         });
     };
+    /**
+     * Gets the email with the corresponding id
+     *
+     * @param id - The id of the email
+     * @returns The email with the corresponding id - `EmailResponse`
+     */
     MailApi.prototype.getEmail = function (id) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.client.get("".concat(this.apiUrl, "/email/").concat(id), this.headers())];
+                return [2 /*return*/, this.client.get("/email/".concat(id), this.headers())];
             });
         });
     };
+    /**
+     * Deletes the email with the corresponding id
+     *
+     * @param id - The id of the email to delete
+     * @returns A promise that resolves when the email is deleted
+     */
     MailApi.prototype.deleteEmail = function (id) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.client.delete("".concat(this.apiUrl, "/email/").concat(id), this.headers())];
+                return [2 /*return*/, this.client.delete("/email/".concat(id), this.headers())];
             });
         });
     };
+    /**
+     * Updates the email with the corresponding id
+     *
+     * @param id - The id of the email to update
+     * @param body - The new body of the email
+     * @returns A promise that resolves when the email is updated
+     */
     MailApi.prototype.updateEmail = function (id, body) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.client.patch("".concat(this.apiUrl, "/email/").concat(id), body, this.headers())];
+                return [2 /*return*/, this.client.patch("/email/".concat(id), body, this.headers())];
             });
         });
     };
+    /**
+     * Sends an email to the specified recipients
+     *
+     * @param body - The body of the email to send
+     * @returns The created email
+     */
     MailApi.prototype.sendEmail = function (body) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.client.post("".concat(this.apiUrl, "/email/send"), body, this.headers())];
+                return [2 /*return*/, this.client.post('/email/send', body, this.headers())];
             });
         });
     };
+    /**
+     * Saves a draft email
+     *
+     * @param body - The body of the draft email to save
+     * @returns The created email - `EmailCreatedResponse`
+     */
     MailApi.prototype.saveDraft = function (body) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
-                return [2 /*return*/, this.client.post("".concat(this.apiUrl, "/email/drafts"), body, this.headers())];
+                return [2 /*return*/, this.client.post('/email/drafts', body, this.headers())];
+            });
+        });
+    };
+    /**
+     * Returns the list of active domains for the email gateway
+     *
+     * @returns The list of active domains - `ActiveDomainsResponse`
+     */
+    MailApi.prototype.getActiveDomains = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.client.get('/email/domains', this.headers())];
+            });
+        });
+    };
+    /**
+     * Sets up a mail account for the user
+     *
+     * @param payload - Set of details for mail account setup
+     * @returns A promise that resolves with the created mail account address
+     */
+    MailApi.prototype.setupMailAccount = function (payload) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.client.post('/users/me/mail-account', payload, this.headers())];
+            });
+        });
+    };
+    /**
+     * Gets the mail account keys for the given address
+     *
+     * @param address - The mail address whose keys should be retrieved
+     * @returns The public, encrypted private and recovery keys plus the salt
+     */
+    MailApi.prototype.getMailAccountKeys = function (address) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.client.getWithParams('/users/me/mail-account/keys', { address: address }, this.headers())];
             });
         });
     };

package/dist/mail/mail.d.ts

@@ -1,6 +1,6 @@
 import { ApiSecurity, ApiUrl, AppDetails } from '../shared';
 import { EncryptedKeystore, KeystoreType, HybridEncryptedEmail, PwdProtectedEmail, HybridKeyPair, Email, RecipientWithPublicKey, EmailPublicParameters } from 'internxt-crypto';
-import { MailboxResponse, EmailListResponse, EmailResponse, EmailCreatedResponse, SendEmailRequest, DraftEmailRequest, UpdateEmailRequest, ListEmailsQuery } from './types';
+import { MailboxResponse, EmailListResponse, EmailResponse, EmailCreatedResponse, SendEmailRequest, DraftEmailRequest, UpdateEmailRequest, ListEmailsQuery, SearchFiltersQuery, EmailDomainsResponse, SetupMailAccountPayload, MailAccountKeysResponse } from './types';
 export declare class Mail {
     private readonly api;
     static client(apiUrl: ApiUrl, appDetails: AppDetails, apiSecurity: ApiSecurity): Mail;
@@ -94,11 +94,69 @@ export declare class Mail {
      * @returns Server response
      */
     e2ePasswordProtectAndSendEmail(email: Email, pwd: string, aux?: string): Promise<void>;
+    /**
+     * Gets the mailboxes of the user
+     *
+     * @returns The mailboxes of the user
+     */
     getMailboxes(): Promise<MailboxResponse[]>;
+    /**
+     * Lists emails of the user
+     *
+     * @param query - The query to filter emails
+     * @returns The list of emails
+     */
     listEmails(query?: ListEmailsQuery): Promise<EmailListResponse>;
+    /**
+     * Gets the email with the corresponding id
+     *
+     * @param id - The id of the email
+     * @returns The email with the corresponding id
+     */
     getEmail(id: string): Promise<EmailResponse>;
+    /**
+     * Deletes the email with the corresponding id
+     *
+     * @param id - The id of the email to delete
+     */
     deleteEmail(id: string): Promise<void>;
+    /**
+     * Updates the email with the corresponding id
+     *
+     * @param id - The id of the email to update
+     * @param body - The new body of the email
+     */
     updateEmail(id: string, body: UpdateEmailRequest): Promise<void>;
+    /**
+     * Sends an email to the specified recipients
+     *
+     * @param body - The body of the email to send
+     * @returns The created email
+     */
     sendEmail(body: SendEmailRequest): Promise<EmailCreatedResponse>;
+    /**
+     * Saves a draft email.
+     *
+     * @param body - The body of the email to save as a draft
+     * @returns The created email
+     */
     saveDraft(body: DraftEmailRequest): Promise<EmailCreatedResponse>;
+    search(filters: SearchFiltersQuery): Promise<EmailListResponse>;
+    getActiveDomains(): Promise<EmailDomainsResponse>;
+    /**
+     * Sets up a mail account for the user
+     *
+     * @param payload - Set of details for mail account setup
+     * @returns A promise that resolves with the created mail account address
+     */
+    setupMailAccount(payload: SetupMailAccountPayload): Promise<{
+        address: string;
+    }>;
+    /**
+     * Gets the mail account keys for the given address
+     *
+     * @param address - The mail address whose keys should be retrieved
+     * @returns The public, encrypted private and recovery keys plus the salt
+     */
+    getMailAccountKeys(address: string): Promise<MailAccountKeysResponse>;
 }

package/dist/mail/mail.js

@@ -248,6 +248,11 @@ var Mail = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Gets the mailboxes of the user
+     *
+     * @returns The mailboxes of the user
+     */
     Mail.prototype.getMailboxes = function () {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -255,6 +260,12 @@ var Mail = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Lists emails of the user
+     *
+     * @param query - The query to filter emails
+     * @returns The list of emails
+     */
     Mail.prototype.listEmails = function (query) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -262,6 +273,12 @@ var Mail = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Gets the email with the corresponding id
+     *
+     * @param id - The id of the email
+     * @returns The email with the corresponding id
+     */
     Mail.prototype.getEmail = function (id) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -269,6 +286,11 @@ var Mail = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Deletes the email with the corresponding id
+     *
+     * @param id - The id of the email to delete
+     */
     Mail.prototype.deleteEmail = function (id) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -276,6 +298,12 @@ var Mail = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Updates the email with the corresponding id
+     *
+     * @param id - The id of the email to update
+     * @param body - The new body of the email
+     */
     Mail.prototype.updateEmail = function (id, body) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -283,6 +311,12 @@ var Mail = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Sends an email to the specified recipients
+     *
+     * @param body - The body of the email to send
+     * @returns The created email
+     */
     Mail.prototype.sendEmail = function (body) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -290,6 +324,12 @@ var Mail = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Saves a draft email.
+     *
+     * @param body - The body of the email to save as a draft
+     * @returns The created email
+     */
     Mail.prototype.saveDraft = function (body) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -297,6 +337,46 @@ var Mail = /** @class */ (function () {
             });
         });
     };
+    Mail.prototype.search = function (filters) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.api.search(filters)];
+            });
+        });
+    };
+    Mail.prototype.getActiveDomains = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.api.getActiveDomains()];
+            });
+        });
+    };
+    /**
+     * Sets up a mail account for the user
+     *
+     * @param payload - Set of details for mail account setup
+     * @returns A promise that resolves with the created mail account address
+     */
+    Mail.prototype.setupMailAccount = function (payload) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.api.setupMailAccount(payload)];
+            });
+        });
+    };
+    /**
+     * Gets the mail account keys for the given address
+     *
+     * @param address - The mail address whose keys should be retrieved
+     * @returns The public, encrypted private and recovery keys plus the salt
+     */
+    Mail.prototype.getMailAccountKeys = function (address) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.api.getMailAccountKeys(address)];
+            });
+        });
+    };
     return Mail;
 }());
 exports.Mail = Mail;

package/dist/mail/schema.d.ts

@@ -19,6 +19,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    '/email/domains': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List domains
+         * @description Returns every domain for the authenticated user.
+         */
+        get: operations['EmailController_getDomains'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/email/mailboxes': {
         parameters: {
             query?: never;
@@ -59,6 +79,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    '/email/search': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Search emails
+         * @description Search emails by text, sender, recipient, date range, read status or attachment.
+         */
+        post: operations['EmailController_search'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/email/{id}': {
         parameters: {
             query?: never;
@@ -199,6 +239,18 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        MailDomainDto: {
+            /** @example f3a1b2c4-… */
+            id: string;
+            /** @example active */
+            status: string;
+            /** @example internxt.me */
+            domain: string;
+            /** @example 2025-06-15T10:29:55Z */
+            createdAt: string;
+            /** @example 2025-06-15T10:29:55Z */
+            updatedAt: string;
+        };
         MailboxResponseDto: {
             /** @example f3a1b2c4-… */
             id: string;
@@ -269,6 +321,38 @@ export interface components {
             /** @example Ma1f09b… */
             nextAnchor?: string;
         };
+        SearchEmailQueryDto: {
+            /** @description Full-text search */
+            text?: string;
+            /** @example 20 */
+            limit?: number;
+            /** @example 0 */
+            position?: number;
+            /**
+             * @description Filter by sender
+             * @example [
+             *       "a@inxt.eu",
+             *       "b@inxt.me"
+             *     ]
+             */
+            from?: string[];
+            /**
+             * @description Filter by recipient
+             * @example [
+             *       "a@inxt.eu",
+             *       "b@inxt.me"
+             *     ]
+             */
+            to?: string[];
+            /** @description ISO 8601 date — emails received after this date */
+            after?: string;
+            /** @description ISO 8601 date — emails received before this date */
+            before?: string;
+            /** @description Filter by read status */
+            unread?: boolean;
+            /** @description Filter by attachment presence */
+            hasAttachment?: boolean;
+        };
         EmailResponseDto: {
             /** @example Ma1f09b… */
             id: string;
@@ -412,6 +496,25 @@ export interface operations {
             };
         };
     };
+    EmailController_getDomains: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['MailDomainDto'][];
+                };
+            };
+        };
+    };
     EmailController_getMailboxes: {
         parameters: {
             query?: never;
@@ -442,6 +545,8 @@ export interface operations {
                 position?: number;
                 /** @description Anchor ID for pagination. */
                 anchorId?: string;
+                /** @description Filter by read status. */
+                unread?: boolean;
             };
             header?: never;
             path?: never;
@@ -459,6 +564,29 @@ export interface operations {
             };
         };
     };
+    EmailController_search: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                'application/json': components['schemas']['SearchEmailQueryDto'];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/json': components['schemas']['EmailListResponseDto'];
+                };
+            };
+        };
+    };
     EmailController_get: {
         parameters: {
             query?: never;

package/dist/mail/types.d.ts

@@ -9,3 +9,22 @@ export type DraftEmailRequest = components['schemas']['DraftEmailRequestDto'];
 export type UpdateEmailRequest = components['schemas']['UpdateEmailRequestDto'];
 export type EmailAddress = components['schemas']['EmailAddressDto'];
 export type ListEmailsQuery = operations['EmailController_list']['parameters']['query'];
+export type SearchFiltersQuery = operations['EmailController_search']['requestBody']['content']['application/json'];
+export type EmailDomainsResponse = components['schemas']['MailDomainDto'][];
+export type SetupMailAccountPayload = {
+    address: string;
+    domain: string;
+    displayName: string;
+    password: string;
+    keys: {
+        publicKey: string;
+        encryptionPrivateKey: string;
+        recoveryPrivateKey: string;
+    };
+};
+export type MailAccountKeysResponse = {
+    address: string;
+    publicKey: string;
+    encryptionPrivateKey: string;
+    recoveryPrivateKey: string;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@internxt/sdk",
   "author": "Internxt <hello@internxt.com>",
-  "version": "1.15.10",
+  "version": "1.15.12",
   "description": "An sdk for interacting with Internxt's services",
   "repository": {
     "type": "git",
@@ -51,4 +51,4 @@
       "prettier --write"
     ]
   }
-}
+}