gimap/protocol/GmailProtocol.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2015 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.mail.gimap.protocol;

import java.io.*;
import java.util.*;

import com.sun.mail.iap.*;
import com.sun.mail.imap.protocol.*;
import com.sun.mail.gimap.GmailFolder.FetchProfileItem;

import com.sun.mail.util.MailLogger;

/**
 * Extend IMAP support to handle Gmail-specific protocol extensions.
 *
 * @since JavaMail 1.4.6
 * @author Bill Shannon
 */

public class GmailProtocol extends IMAPProtocol {

    /*
     * Define the Gmail-specific FETCH items.
     */
    public static final FetchItem MSGID_ITEM =
    new FetchItem("X-GM-MSGID", FetchProfileItem.MSGID) {
        public Object parseItem(FetchResponse r) {
        return Long.valueOf(r.readLong());
        }
    };
    public static final FetchItem THRID_ITEM =
    new FetchItem("X-GM-THRID", FetchProfileItem.THRID) {
        public Object parseItem(FetchResponse r) {
        return Long.valueOf(r.readLong());
        }
    };
    public static final FetchItem LABELS_ITEM =
    new FetchItem("X-GM-LABELS", FetchProfileItem.LABELS) {
        public Object parseItem(FetchResponse r) {
        return r.readAtomStringList();
        }
    };

    private static final FetchItem[] myFetchItems = {
    MSGID_ITEM,
    THRID_ITEM,
    LABELS_ITEM
    };

    private FetchItem[] fetchItems = null;

    /**
     * Connect to Gmail.
     *
     * @param name  the protocol name
     * @param host  host to connect to
     * @param port  portnumber to connect to
     * @param props Properties object used by this protocol
     * @param isSSL use SSL?
     * @param logger    for log messages
     * @exception   IOException for I/O errors
     * @exception   ProtocolException   for protocol failures
     */
    public GmailProtocol(String name, String host, int port,
            Properties props, boolean isSSL, MailLogger logger)
            throws IOException, ProtocolException {
    super(name, host, port, props, isSSL, logger);

    // check to see if this is really Gmail
    if (!hasCapability("X-GM-EXT-1")) {
        logger.fine("WARNING! Not connected to Gmail!");
        // XXX - could call "disconnect()" here and make this a fatal error
    } else {
        logger.fine("connected to Gmail");
    }
    }

    /**
     * Return the additional fetch items supported by the Gmail protocol.
     * Combines our fetch items with those supported by the superclass.
     */
    public FetchItem[] getFetchItems() {
    if (fetchItems != null)
        return fetchItems;
    FetchItem[] sfi = super.getFetchItems();
    if (sfi == null || sfi.length == 0)
        fetchItems = myFetchItems;
    else {
        fetchItems = new FetchItem[sfi.length + myFetchItems.length];
        System.arraycopy(sfi, 0, fetchItems, 0, sfi.length);
        System.arraycopy(myFetchItems, 0, fetchItems, sfi.length,
                            myFetchItems.length);
    }
    return fetchItems;
    }

    /**
     * Set the specified labels on this message.
     *
     * @param   msgsets the message sets
     * @param   labels  the labels
     * @param   set true to set, false to clear
     * @exception   ProtocolException   for protocol failures
     * @since   JavaMail 1.5.5
     */
    public void storeLabels(MessageSet[] msgsets, String[] labels, boolean set)
            throws ProtocolException {
    storeLabels(MessageSet.toString(msgsets), labels, set);
    }

    /**
     * Set the specified labels on this message.
     *
     * @param   start   the first message number
     * @param   end the last message number
     * @param   labels  the labels
     * @param   set true to set, false to clear
     * @exception   ProtocolException   for protocol failures
     * @since   JavaMail 1.5.5
     */
    public void storeLabels(int start, int end, String[] labels, boolean set)
            throws ProtocolException {
    storeLabels(String.valueOf(start) + ":" + String.valueOf(end),
           labels, set);
    }

    /**
     * Set the specified labels on this message.
     *
     * @param   msg the message number
     * @param   labels  the labels
     * @param   set true to set, false to clear
     * @exception   ProtocolException   for protocol failures
     * @since   JavaMail 1.5.5
     */
    public void storeLabels(int msg, String[] labels, boolean set)
            throws ProtocolException {
    storeLabels(String.valueOf(msg), labels, set);
    }

    private void storeLabels(String msgset, String[] labels, boolean set)
            throws ProtocolException {
    Response[] r;
    if (set)
        r = command("STORE " + msgset + " +X-GM-LABELS",
             createLabelList(labels));
    else
        r = command("STORE " + msgset + " -X-GM-LABELS",
            createLabelList(labels));

    // Dispatch untagged responses
    notifyResponseHandlers(r);
    handleResult(r[r.length-1]);
    }

    private Argument createLabelList(String[] labels) {
    Argument args = new Argument();
    Argument itemArgs = new Argument();
    for (int i = 0, len = labels.length; i < len; i++)
        itemArgs.writeAtom(labels[i]);
    args.writeArgument(itemArgs);
    return args;
    }

    /**
     * Return a GmailSearchSequence.
     */
    protected SearchSequence getSearchSequence() {
    if (searchSequence == null)
        searchSequence = new GmailSearchSequence();
    return searchSequence;
    }
}