139 lines
4.8 KiB
Java
139 lines
4.8 KiB
Java
/*
|
|
* Copyright (C) 2008 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package com.android.email.mail;
|
|
|
|
|
|
public abstract class Folder {
|
|
public enum OpenMode {
|
|
READ_WRITE, READ_ONLY,
|
|
}
|
|
|
|
public enum FolderType {
|
|
HOLDS_FOLDERS, HOLDS_MESSAGES,
|
|
}
|
|
|
|
/**
|
|
* Forces an open of the MailProvider. If the provider is already open this
|
|
* function returns without doing anything.
|
|
*
|
|
* @param mode READ_ONLY or READ_WRITE
|
|
* @param callbacks Pointer to callbacks class. This may be used by the folder between this
|
|
* time and when close() is called. This is only used for remote stores - should be null
|
|
* for LocalStore.LocalFolder.
|
|
*/
|
|
public abstract void open(OpenMode mode, PersistentDataCallbacks callbacks)
|
|
throws MessagingException;
|
|
|
|
/**
|
|
* Forces a close of the MailProvider. Any further access will attempt to
|
|
* reopen the MailProvider.
|
|
*
|
|
* @param expunge If true all deleted messages will be expunged.
|
|
*/
|
|
public abstract void close(boolean expunge) throws MessagingException;
|
|
|
|
/**
|
|
* @return True if further commands are not expected to have to open the
|
|
* connection.
|
|
*/
|
|
// TODO not used, get rid of this - it's a transport function
|
|
public abstract boolean isOpen();
|
|
|
|
/**
|
|
* Get the mode the folder was opened with. This may be different than the mode the open
|
|
* was requested with.
|
|
* @return
|
|
*/
|
|
public abstract OpenMode getMode() throws MessagingException;
|
|
|
|
public abstract boolean create(FolderType type) throws MessagingException;
|
|
|
|
public abstract boolean exists() throws MessagingException;
|
|
|
|
/**
|
|
* @return A count of the messages in the selected folder.
|
|
*/
|
|
public abstract int getMessageCount() throws MessagingException;
|
|
|
|
public abstract int getUnreadMessageCount() throws MessagingException;
|
|
|
|
public abstract Message getMessage(String uid) throws MessagingException;
|
|
|
|
public abstract Message[] getMessages(int start, int end, MessageRetrievalListener listener)
|
|
throws MessagingException;
|
|
|
|
/**
|
|
* Fetches the given list of messages. The specified listener is notified as
|
|
* each fetch completes. Messages are downloaded as (as) lightweight (as
|
|
* possible) objects to be filled in with later requests. In most cases this
|
|
* means that only the UID is downloaded.
|
|
*
|
|
* @param uids
|
|
* @param listener
|
|
*/
|
|
public abstract Message[] getMessages(MessageRetrievalListener listener)
|
|
throws MessagingException;
|
|
|
|
public abstract Message[] getMessages(String[] uids, MessageRetrievalListener listener)
|
|
throws MessagingException;
|
|
|
|
public abstract void appendMessages(Message[] messages) throws MessagingException;
|
|
|
|
public abstract void copyMessages(Message[] msgs, Folder folder) throws MessagingException;
|
|
|
|
public abstract void setFlags(Message[] messages, Flag[] flags, boolean value)
|
|
throws MessagingException;
|
|
|
|
public abstract Message[] expunge() throws MessagingException;
|
|
|
|
public abstract void fetch(Message[] messages, FetchProfile fp,
|
|
MessageRetrievalListener listener) throws MessagingException;
|
|
|
|
public abstract void delete(boolean recurse) throws MessagingException;
|
|
|
|
public abstract String getName();
|
|
|
|
public abstract Flag[] getPermanentFlags() throws MessagingException;
|
|
|
|
/**
|
|
* Callback interface by which a Folder can read and write persistent data.
|
|
* TODO This needs to be made more generic & flexible
|
|
*/
|
|
public interface PersistentDataCallbacks {
|
|
|
|
/**
|
|
* Provides keyed storage of strings. Should be used for per-folder data. Do not use for
|
|
* per-message data.
|
|
* @param key identifier for the data (e.g. "sync.key" or "folder.id")
|
|
* @param value Data to persist. All data must be encoded into a string,
|
|
* so use base64 or some other encoding if necessary.
|
|
*/
|
|
public void setPersistentString(String key, String value);
|
|
|
|
/**
|
|
* @param key identifier for the data of interest
|
|
* @return the data saved by the Folder, or defaultValue if never set.
|
|
*/
|
|
public String getPersistentString(String key, String defaultValue);
|
|
}
|
|
|
|
@Override
|
|
public String toString() {
|
|
return getName();
|
|
}
|
|
}
|