Commons Net example source code file (POP3MessageInfo.java)

This example Commons Net source code file (POP3MessageInfo.java) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Commons Net tags/keywords

pop3messageinfo, pop3messageinfo, string, string

The Commons Net POP3MessageInfo.java source code

/*
 * 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.commons.net.pop3;

/***
 * POP3MessageInfo is used to return information about messages stored on
 * a POP3 server.  Its fields are used to mean slightly different things
 * depending on the information being returned.
 * <p>
 * In response to a status command, <code> number 
 * contains the number of messages in the mailbox, <code> size 
 * contains the size of the mailbox in bytes, and <code> identifier 
 * is null.
 * <p>
 * In response to a message listings, <code> number 
 * contains the message number, <code> size  contains the
 * size of the message in bytes, and <code> identifier  is null.
 * <p>
 * In response to unique identifier listings, <code> number  contains
 * the message number, <code> size  is undefined, and
 * <code> identifier  contains the message's unique identifier.
 * <p>
 * <p>
 ***/

public final class POP3MessageInfo
{
    public int number;
    public int size;
    public String identifier;

    /***
     * Creates a POP3MessageInfo instance with <code>number and
     * <code> size  set to 0, and identifier set to
     * null.
     ***/
    public POP3MessageInfo()
    {
        this(0, null, 0);
    }

    /***
     * Creates a POP3MessageInfo instance with <code>number set
     * to <code> num ,  size  set to  octets ,
     * and <code>identifier set to null.
     ***/
    public POP3MessageInfo(int num, int octets)
    {
        this(num, null, octets);
    }

    /***
     * Creates a POP3MessageInfo instance with <code>number set
     * to <code> num ,  size  undefined,
     * and <code>identifier set to uid.
     ***/
    public POP3MessageInfo(int num, String uid)
    {
        this(num, uid, -1);
    }

    private POP3MessageInfo(int num, String uid, int size) {
        this.number = num;
        this.size = size;
        this.identifier = uid;
    }
}