1 /**
2 *
3 * Copyright 2003-2006 The Apache Software Foundation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package javax.mail;
19
20 /**
21 * @version $Rev: 421852 $ $Date: 2006-07-14 03:02:19 -0700 (Fri, 14 Jul 2006) $
22 */
23 public interface UIDFolder {
24 /**
25 * A special value than can be passed as the <code>end</code> parameter to
26 * {@link Folder#getMessages(int, int)} to indicate the last message in this folder.
27 */
28 public static final long LASTUID = -1;
29
30 public abstract long getUIDValidity() throws MessagingException;
31
32 public abstract Message getMessageByUID(long uid)
33 throws MessagingException;
34
35 public abstract Message[] getMessagesByUID(long start, long end)
36 throws MessagingException;
37
38 public abstract Message[] getMessagesByUID(long[] ids)
39 throws MessagingException;
40
41 public abstract long getUID(Message message) throws MessagingException;
42
43 public static class FetchProfileItem extends FetchProfile.Item {
44 public static final FetchProfileItem UID = new FetchProfileItem("Uid");
45
46 protected FetchProfileItem(String name) {
47 super(name);
48 }
49 }
50 }