com.groupbyinc.common.apache.commons.net.pop3.POP3MessageInfo 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.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.
*
* In response to a status command, number
* contains the number of messages in the mailbox, size
* contains the size of the mailbox in bytes, and identifier
* is null.
*
* In response to a message listings, number
* contains the message number, size contains the
* size of the message in bytes, and identifier is null.
*
* In response to unique identifier listings, number contains
* the message number, size is undefined, and
* identifier contains the message's unique identifier.
*
*
***/
public final class POP3MessageInfo
{
public int number;
public int size;
public String identifier;
/***
* Creates a POP3MessageInfo instance with number and
* size set to 0, and identifier set to
* null.
***/
public POP3MessageInfo()
{
this(0, null, 0);
}
/***
* Creates a POP3MessageInfo instance with number set
* to num , size set to octets ,
* and identifier set to null.
* @param num the number
* @param octets the size
***/
public POP3MessageInfo(int num, int octets)
{
this(num, null, octets);
}
/***
* Creates a POP3MessageInfo instance with number set
* to num , size undefined,
* and identifier set to uid.
* @param num the number
* @param uid the 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;
}
}