1 package org.apache.commons.net.pop3;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache Commons" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 /****
58 * POP3MessageInfo is used to return information about messages stored on
59 * a POP3 server. Its fields are used to mean slightly different things
60 * depending on the information being returned.
61 * <p>
62 * In response to a status command, <code> number </code>
63 * contains the number of messages in the mailbox, <code> size </code>
64 * contains the size of the mailbox in bytes, and <code> identifier </code>
65 * is null.
66 * <p>
67 * In response to a message listings, <code> number </code>
68 * contains the message number, <code> size </code> contains the
69 * size of the message in bytes, and <code> identifier </code> is null.
70 * <p>
71 * In response to unique identifier listings, <code> number </code> contains
72 * the message number, <code> size </code> is undefined, and
73 * <code> identifier </code> contains the message's unique identifier.
74 * <p>
75 * <p>
76 * @author Daniel F. Savarese
77 ***/
78
79 public final class POP3MessageInfo
80 {
81 public int number;
82 public int size;
83 public String identifier;
84
85 /****
86 * Creates a POP3MessageInfo instance with <code>number</code> and
87 * <code> size </code> set to 0, and <code>identifier</code> set to
88 * null.
89 ***/
90 public POP3MessageInfo()
91 {
92 number = size = 0;
93 identifier = null;
94 }
95
96 /****
97 * Creates a POP3MessageInfo instance with <code>number</code> set
98 * to <code> num </code>, <code> size </code> set to <code> octets </code>,
99 * and <code>identifier</code> set to null.
100 ***/
101 public POP3MessageInfo(int num, int octets)
102 {
103 number = num;
104 size = octets;
105 identifier = null;
106 }
107
108 /****
109 * Creates a POP3MessageInfo instance with <code>number</code> set
110 * to <code> num </code>, <code> size </code> undefined,
111 * and <code>identifier</code> set to <code>uid</code>.
112 ***/
113 public POP3MessageInfo(int num, String uid)
114 {
115 number = num;
116 size = -1;
117 identifier = uid;
118 }
119 }
This page was automatically generated by Maven