mailisk 1.0.3 → 2.0.0

package/README.md

@@ -58,8 +58,18 @@ This library wraps the REST API endpoints. Find out more in the [API Reference](
 
 The `searchInbox` function takes a namespace and call parameters.
 
-- It uses the `wait` property by default. This means the call won't timeout until a result is returned or 5 minutes pass. This is adjustable by passing the `timeout` paramter (it can also be disabled by passing `wait: false`).
-- It uses a default `from_timestamp` of **current timestamp - 5 seconds**. This means that older emails will be ignored. This can be overriden by passing the `from_timestamp` parameter (`from_timestmap: 0` will disable filtering by email age).
+- By default it uses the `wait` flag. This means the call won't return until at least one email is received. Disabling this flag via `wait: false` can cause it to return an empty response immediately.
+- The request timeout is adjustable by passing `timeout` in the request options. By default it uses a timeout of 5 minutes.
+- By default `from_timestamp` is set to **current timestamp - 5 seconds**. This ensures that only new emails are returned. Without this, older emails would also be returned, potentially disrupting you if you were waiting for a specific email. This can be overriden by passing the `from_timestamp` parameter (`from_timestmap: 0` will disable filtering by email age).
+
+```js
+// timeout of 5 minutes
+await mailisk.searchInbox(namespace);
+// timeout of 1 minute
+await mailisk.searchInbox(namespace, {}, { timeout: 1000 * 60 });
+// returns immediately, even if the result would be empty
+await mailisk.searchInbox(namespace, { wait: false });
+```
 
 #### Filter by destination address
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mailisk",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "description": "Mailisk library for NodeJS",
   "keywords": [
     "mailisk",

package/src/mailisk.interfaces.ts

@@ -52,9 +52,21 @@ export interface SearchInboxParams {
   /**
    * Filter emails by 'to' address. Address must start with this.
    *
-   * 'foo' would return 'foobar@namespace.mailisk.net' but not 'barfoo@namespace.mailisk.net'
+   * 'foo' would return for 'foobar@namespace.mailisk.net' but not 'barfoo@namespace.mailisk.net'
    */
   to_addr_prefix?: string;
+  /**
+   * Filter emails by 'from' address. Address must include this.
+   *
+   * '@foo' would return for 'a@foo.com', 'b@foo.net'
+   */
+  from_addr_includes?: string;
+  /**
+   * Filter emails by subject. This is case insensitive. Subject must include this.
+   *
+   * 'password' would return for 'Password reset', 'Reset password notification' but not 'Reset'
+   */
+  subject_includes?: string;
   /**
    * Will keep the request going till at least one email would be returned.
    *

package/src/mailisk.ts

@@ -100,9 +100,9 @@ export class MailiskClient {
   ): Promise<SearchInboxResponse> {
     let _params = { ...params };
 
-    // default from timestamp, 5 seconds before starting this request
+    // default from timestamp, 15 minutes before starting this request
     if (params?.from_timestamp === undefined || params?.from_timestamp === null) {
-      _params.from_timestamp = Math.floor(new Date().getTime() / 1000) - 5;
+      _params.from_timestamp = Math.floor(new Date().getTime() / 1000) - 15 * 60;
     }
 
     // by default wait for email