fix(api): Added quota information to account info response

postalsys · Dec 19, 2023 · 6341400 · 6341400
1 parent ea8a02f
commit 6341400
Show file tree

Hide file tree

Showing 9 changed files with 89 additions and 17 deletions.
diff --git a/lib/account.js b/lib/account.js
@@ -929,6 +929,16 @@ class Account {
         });
     }
 
+    async getQuota() {
+        await this.loadAccountData(this.account, true);
+
+        return await this.call({
+            cmd: 'getQuota',
+            account: this.account,
+            timeout: this.timeout
+        });
+    }
+
     async createMailbox(path) {
         await this.loadAccountData(this.account, true);
 

diff --git a/lib/connection.js b/lib/connection.js
@@ -1671,6 +1671,28 @@ class Connection {
             });
     }
 
+    async getQuota() {
+        this.checkIMAPConnection();
+        try {
+            let result = await this.imapClient.getQuota();
+            return (result && result.storage) || false;
+        } catch (err) {
+            if (err.serverResponseCode) {
+                let error = new Error('Quota request failed');
+                error.info = {
+                    response: err.response && typeof err.response === 'string' && err.response.replace(/^[^\s]*\s*/, '')
+                };
+                error.code = err.serverResponseCode;
+                error.statusCode = 400;
+                throw error;
+            } else if (err.responseStatus === 'NO') {
+                return false;
+            } else {
+                throw err;
+            }
+        }
+    }
+
     async createMailbox(path) {
         this.checkIMAPConnection();
         try {

diff --git a/package.json b/package.json
@@ -57,7 +57,7 @@
         "ace-builds": "1.32.2",
         "base32.js": "0.1.0",
         "bull-arena": "4.1.0",
-        "bullmq": "4.15.4",
+        "bullmq": "4.16.0",
         "compare-versions": "6.1.0",
         "dotenv": "16.3.1",
         "encoding-japanese": "2.0.0",
@@ -94,7 +94,7 @@
         "node-gettext": "3.0.0",
         "nodemailer": "6.9.7",
         "pino": "8.17.1",
-        "prom-client": "15.0.0",
+        "prom-client": "15.1.0",
         "psl": "1.9.0",
         "pubface": "1.0.6",
         "punycode": "2.3.1",
@@ -112,7 +112,7 @@
     "devDependencies": {
         "chai": "4.3.10",
         "eerawlog": "1.5.1",
-        "eslint": "8.55.0",
+        "eslint": "8.56.0",
         "eslint-config-nodemailer": "1.2.0",
         "eslint-config-prettier": "9.1.0",
         "grunt": "1.6.1",

diff --git a/sbom.json b/sbom.json
diff --git a/server.js b/server.js
@@ -1873,6 +1873,7 @@ async function onCommand(worker, message) {
         case 'moveMessages':
         case 'deleteMessage':
         case 'deleteMessages':
+        case 'getQuota':
         case 'createMailbox':
         case 'renameMailbox':
         case 'deleteMailbox':

diff --git a/static/licenses.html b/static/licenses.html
@@ -1,6 +1,6 @@
 <!doctype html><html><head><meta charset="utf-8"><title>EmailEngine Licenses</title><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.6.1/dist/css/bootstrap.min.css" integrity="sha384-zCbKRCUGaJDkqS1kPbPd7TveP5iyJE0EjAuZQTgFLD2ylzuqKfdKlfG/eSrtxUkn" crossorigin="anonymous"></head><body>
 <div class="container-fluid">
-<h1>EmailEngine v2.39.3</h1><p>EmailEngine includes code from the following software packages:</p>
+<h1>EmailEngine v2.39.4</h1><p>EmailEngine includes code from the following software packages:</p>
 <table class="table table-sm">
 <tr><thead class="thead-dark"><th>Package</th><th>Version</th><th>License</th><th>Publisher</th><th>Publisher's Email</th><th>Package URL</th></tr>
 <tbody>
@@ -236,7 +236,7 @@ <h1>EmailEngine v2.39.3</h1><p>EmailEngine includes code from the following soft
 </tr>
 <tr>
 <td><a href="https://npmjs.com/package/@eslint/js">@eslint/js</a></td>
-<td>8.55.0</td>
+<td>8.56.0</td>
 <td>MIT</td>
 <td></td>
 <td></td>
@@ -1616,7 +1616,7 @@ <h1>EmailEngine v2.39.3</h1><p>EmailEngine includes code from the following soft
 </tr>
 <tr>
 <td><a href="https://npmjs.com/package/bullmq">bullmq</a></td>
-<td>4.15.4</td>
+<td>4.16.0</td>
 <td>MIT</td>
 <td>Taskforce.sh Inc.</td>
 <td></td>
@@ -2735,7 +2735,7 @@ <h1>EmailEngine v2.39.3</h1><p>EmailEngine includes code from the following soft
 </tr>
 <tr>
 <td><a href="https://npmjs.com/package/eslint">eslint</a></td>
-<td>8.55.0</td>
+<td>8.56.0</td>
 <td>MIT</td>
 <td>Nicholas C. Zakas</td>
 <td>nicholas+npm@nczconsulting.com</td>
@@ -3005,7 +3005,7 @@ <h1>EmailEngine v2.39.3</h1><p>EmailEngine includes code from the following soft
 </tr>
 <tr>
 <td><a href="https://npmjs.com/package/fastq">fastq</a></td>
-<td>1.15.0</td>
+<td>1.16.0</td>
 <td>ISC</td>
 <td>Matteo Collina</td>
 <td>hello@matteocollina.com</td>
@@ -6225,7 +6225,7 @@ <h1>EmailEngine v2.39.3</h1><p>EmailEngine includes code from the following soft
 </tr>
 <tr>
 <td><a href="https://npmjs.com/package/prom-client">prom-client</a></td>
-<td>15.0.0</td>
+<td>15.1.0</td>
 <td>Apache-2.0</td>
 <td>Simon Nyberg</td>
 <td></td>
@@ -6455,7 +6455,7 @@ <h1>EmailEngine v2.39.3</h1><p>EmailEngine includes code from the following soft
 </tr>
 <tr>
 <td><a href="https://npmjs.com/package/readable-stream">readable-stream</a></td>
-<td>4.4.2</td>
+<td>4.5.1</td>
 <td>MIT</td>
 <td></td>
 <td></td>
@@ -6525,7 +6525,7 @@ <h1>EmailEngine v2.39.3</h1><p>EmailEngine includes code from the following soft
 </tr>
 <tr>
 <td><a href="https://npmjs.com/package/regenerator-runtime">regenerator-runtime</a></td>
-<td>0.14.0</td>
+<td>0.14.1</td>
 <td>MIT</td>
 <td>Ben Newman</td>
 <td>bn@cs.stanford.edu</td>

diff --git a/translations/messages.pot b/translations/messages.pot
@@ -1,14 +1,18 @@
 msgid ""
 msgstr ""
 "Content-Type: text/plain; charset=ascii\n"
-"POT-Creation-Date: 2023-12-15 12:45+0000\n"
+"POT-Creation-Date: 2023-12-19 11:03+0000\n"
 
 #: views/config/license.hbs:48
 msgid "%d day"
 msgid_plural "%d days"
 msgstr[0] ""
 msgstr[1] ""
 
+#: views/redirect.hbs:1
+msgid "Click <a href=\"%s\">here</a> to continue&mldr;"
+msgstr ""
+
 #: views/unsubscribe.hbs:1
 #: views/unsubscribe.hbs:79
 msgid "Unsubscribe"
@@ -53,10 +57,6 @@ msgstr ""
 msgid "Enter your email address"
 msgstr ""
 
-#: views/redirect.hbs:1
-msgid "Click <a href=\"%s\">here</a> to continue&mldr;"
-msgstr ""
-
 #: views/accounts/register/imap.hbs:11
 msgid "Your name"
 msgstr ""

diff --git a/workers/api.js b/workers/api.js
@@ -2872,6 +2872,10 @@ When making API calls remember that requests against the same account are queued
                     result.counters = accountData.counters;
                 }
 
+                if (request.query.quota) {
+                    result.quota = await accountObject.getQuota();
+                }
+
                 return result;
             } catch (err) {
                 request.logger.error({ msg: 'API request failed', err });
@@ -2906,6 +2910,15 @@ When making API calls remember that requests against the same account are queued
 
                 params: Joi.object({
                     account: accountIdSchema.required()
+                }),
+
+                query: Joi.object({
+                    quota: Joi.boolean()
+                        .truthy('Y', 'true', '1')
+                        .falsy('N', 'false', 0)
+                        .default(false)
+                        .description('If true, then include quota information in the response')
+                        .label('AccountQuota')
                 })
             },
 
@@ -2957,11 +2970,23 @@ When making API calls remember that requests against the same account are queued
                         .valid(...['imap'].concat(Object.keys(OAUTH_PROVIDERS)).concat('oauth2'))
                         .example('outlook')
                         .description('Account type')
+                        .label('AccountType')
                         .required(),
                     app: Joi.string().max(256).example('AAABhaBPHscAAAAH').description('OAuth2 application ID'),
 
                     counters: accountCountersSchema,
 
+                    quota: Joi.object({
+                        usage: Joi.number().example(8547884032).description('How many bytes has the account stored in emails'),
+                        limit: Joi.number().example(16106127360).description('How many bytes can the account store emails'),
+                        status: Joi.string().example('53%').description('Textual information about the usage')
+                    })
+                        .label('AccountQuota')
+                        .allow(false)
+                        .description(
+                            'Account quota information if query argument quota=true. This value will be false if the server does not provide quota information.'
+                        ),
+
                     syncTime: Joi.date().iso().example('2021-02-17T13:43:18.860Z').description('Last sync time'),
 
                     lastError: lastErrorSchema.allow(null)

diff --git a/workers/imap.js b/workers/imap.js
@@ -439,6 +439,19 @@ class ConnectionHandler {
         return await accountData.connection.uploadMessage(message.data);
     }
 
+    async getQuota(message) {
+        if (!this.accounts.has(message.account)) {
+            return NO_ACTIVE_HANDLER_RESP;
+        }
+
+        let accountData = this.accounts.get(message.account);
+        if (!accountData.connection) {
+            return NO_ACTIVE_HANDLER_RESP;
+        }
+
+        return await accountData.connection.getQuota();
+    }
+
     async createMailbox(message) {
         if (!this.accounts.has(message.account)) {
             return NO_ACTIVE_HANDLER_RESP;
@@ -607,6 +620,7 @@ class ConnectionHandler {
             case 'deleteMessage':
             case 'deleteMessages':
             case 'getRawMessage':
+            case 'getQuota':
             case 'createMailbox':
             case 'renameMailbox':
             case 'deleteMailbox':