org.apache.james.imap.api.process.SelectedMailbox Maven / Gradle / Ivy
/****************************************************************
* Licensed to the Apache Software Foundation (ASF) under one *
* or more contributor license agreements. See the NOTICE file *
* distributed with this work for additional information *
* regarding copyright ownership. The ASF licenses this file *
* to you 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 org.apache.james.imap.api.process;
import java.util.Collection;
import org.apache.james.mailbox.MailboxPath;
/**
* Interface which represent a selected Mailbox during the selected state
*
*/
public interface SelectedMailbox {
/**
* Deselect the Mailbox
*/
public abstract void deselect();
/**
* Return the msg index of the given uid
*
* @param uid
* @return index
*/
public int msn(long uid);
/**
* Return the uid of the message for the given index
* @param index
* @return uid
*/
public abstract long uid(int index);
/**
* Add a recent uid
*
* @param uid
* @return true if it was successfully
*/
public boolean addRecent(long uid);
/**
* Remove a recent uid
* @param uid
* @return true if it was successfully
*/
public boolean removeRecent(long uid);
/**
* Return a Collection of all recent uids
*
* @return recentUids
*/
public Collection getRecent();
/**
* Return the count of all recent uids
*
* @return recentCount
*/
public int recentCount();
/**
* Return the path of the selected Mailbox
*
* @return path
*/
public MailboxPath getPath();
/**
* Is the given uid recent ?
*
* @param uid
* @return true if the given uid is recent
*/
public boolean isRecent(long uid);
/**
* Is the mailbox deleted?
*
* @return true when the mailbox has been deleted by another session, false
* otherwise
*/
public boolean isDeletedByOtherSession();
/**
* Is the size of the mailbox changed ?
*
* @return true if the mailbox size was changed
*/
public boolean isSizeChanged();
/**
* Was the recent uid removed ?
*
* @return true if the recent uid for this mailbox was removed
*/
public boolean isRecentUidRemoved();
/**
*
*/
public void resetRecentUidRemoved();
/**
* Reset all events
*/
public void resetEvents();
/**
* Return a Collection which holds all uids which were expunged
*
* @return expungedUids
*/
public Collection expungedUids();
/**
* Removes the given UID.
* @param uid not null
* @return the message sequence number that the UID held before
* being expunged
*/
public int remove(Long uid);
/**
* Return a Collection which holds all uids reflecting the Messages which flags were updated
*
* @return flagsUids
*/
public Collection flagUpdateUids();
}