Android™

IMAP Get Quota Root

Sends the GETQUOTAROOT command to the IMAP server to get the quota root for a given mailbox. This also provides quota information for the given mailbox.

The GetQuotaRoot 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.

Android™

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    boolean success = false;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkImap imap = new CkImap();

    // Use TLS
    imap.put_Ssl(true);
    imap.put_Port(993);
    success = imap.Connect("MY-IMAP-DOMAIN");
    if (success != true) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    // Authenticate
    success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD");
    if (success != true) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    // First check to see if the IMAP server supports the QUOTA extension.
    String caps = imap.capability();
    if (imap.get_LastMethodSuccess() != true) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

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

    String jsonStr = imap.getQuotaRoot("Inbox");
    if (imap.get_LastMethodSuccess() != true) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    // The JSON string will look something like this:
    // {"QUOTAROOT":{"mailbox":"Inbox","root":""},"QUOTA":{"root":"","resource":"STORAGE","used":22216,"max":15728640}}
    Log.i(TAG, jsonStr);

    // This is easy to parse...
    CkJsonObject json = new CkJsonObject();
    json.Load(jsonStr);

    // Get the quota root for Inbox, which is an empty string in the case above.
    String quotaRoot = json.stringOf("QUOTAROOT.root");
    Log.i(TAG, "Quota Root for Inbox: [" + quotaRoot + "]");

    // 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.
    String resourceName = json.stringOf("QUOTA.resource");
    int quotaUsed = json.IntOf("QUOTA.used");
    int quotaMax = json.IntOf("QUOTA.max");

    Log.i(TAG, "Resource: " + resourceName);
    Log.i(TAG, "Quota Used (in KB): " + String.valueOf(quotaUsed));
    Log.i(TAG, "Quota Max (in KB): " + String.valueOf(quotaMax));

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

  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}