Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Node.js Examples

ASN.1
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
Facebook
FileAccess
Firebase
GMail REST API
GeoOp
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Sheets
Gzip
HTML-to-XML/Text
HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)

Java KeyStore (JKS)
Jira
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
PayPal
Peoplevox
QuickBooks
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Shopify
Socket/SSL/TLS
Spider
Stream
Stripe
SugarCRM
Tar Archive
Twitter
Upload
VoiceBase
Walmart
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Xero
Zip
curl
eBay

 

 

 

(Node.js) IMAP Get Quota

Sends the GETQUOTA command to the IMAP server to get the quota information for a given quota root.

The GetQuota method is available in Chilkat starting at v9.5.0.58, and is only available for IMAP servers that support the QUOTA extension.

The information is returned in JSON format. This example demonstrates how to parse the JSON to get the desired information.

Typically, the quota root for the Inbox is the empty string. The GetQuotaRoot method can be called to get the quota root for a given mailbox.

Install Chilkat for Node.js and Electron using npm at

Chilkat npm packages for Node.js

Chilkat npm packages for Electron

on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node11-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node11-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node11-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node11-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node11-linux64');
    }
} else if (os.platform() == 'darwin') {
    var chilkat = require('@chilkat/ck-node11-macosx');
}

function chilkatExample() {

    var imap = new chilkat.Imap();

    var success;

    // Anything unlocks the component and begins a fully-functional 30-day trial.
    success = imap.UnlockComponent("Anything for 30-day trial");
    if (success !== true) {
        console.log(imap.LastErrorText);
        return;
    }

    // Use TLS
    imap.Ssl = true;
    imap.Port = 993;
    success = imap.Connect("MY-IMAP-DOMAIN");
    if (success !== true) {
        console.log(imap.LastErrorText);
        return;
    }

    // Authenticate
    success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD");
    if (success !== true) {
        console.log(imap.LastErrorText);
        return;
    }

    // First check to see if the IMAP server supports the QUOTA extension.
    var caps = imap.Capability();
    if (imap.LastMethodSuccess !== true) {
        console.log(imap.LastErrorText);
        return;
    }

    if (imap.HasCapability("QUOTA",caps) !== true) {
        console.log("IMAP server does not support the QUOTA extension.");
        return;
    }

    // This example assumes we already know the quota root for the given mailbox.
    // For Inbox, it is typically the empty string.  See the documentation and example 
    // for the GetQuotaRoot method to query for the quota root of a mailbox.  
    // (It's probably easier to use GetQuotaRoot because the mailbox name
    // can be passed to it, and in addition, it returns the quota information.)
    // method for details 
    var jsonStr = imap.GetQuota("");
    if (imap.LastMethodSuccess !== true) {
        console.log(imap.LastErrorText);
        return;
    }

    // The JSON string will look something like this:
    // {"QUOTA":{"root":"","resource":"STORAGE","used":22216,"max":15728640}}
    console.log(jsonStr);

    // This is easy to parse...
    var json = new chilkat.JsonObject();
    json.Load(jsonStr);

    // Now get the resource name (which can be STORAGE or MESSAGE) and the used/max values.
    // Most servers have STORAGE quotas, which are for total capacity.  For example, GMail's
    // STORAGE quota is 15GB (at the time of writing this example).
    // A MESSAGE quota sets a limit on the number of messages.
    var resourceName = json.StringOf("QUOTA.resource");
    var quotaUsed = json.IntOf("QUOTA.used");
    var quotaMax = json.IntOf("QUOTA.max");

    console.log("Resource: " + resourceName);
    console.log("Quota Used (in KB): " + quotaUsed);
    console.log("Quota Max (in KB): " + quotaMax);

    // Disconnect from the IMAP server.
    success = imap.Disconnect();

}

chilkatExample();

 

© 2000-2016 Chilkat Software, Inc. All Rights Reserved.