⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.net.pop3

Class POP3MessageInfo

java.lang.Object
|
+--org.apache.commons.net.pop3.POP3MessageInfo


public final class POP3MessageInfo
extends java.lang.Object

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.

Author:
Daniel F. Savarese

Field Summary

String

identifier

int

number

POP3MessageInfo is used to return information about messages stored on a POP3 server.

int

size

Constructor Summary

POP3MessageInfo()

Creates a POP3MessageInfo instance with number and size set to 0, and identifier set to null.

POP3MessageInfo(int num, int octets)

Creates a POP3MessageInfo instance with number set to num , size set to octets , and identifier set to null.

POP3MessageInfo(int num, String uid)

Creates a POP3MessageInfo instance with number set to num , size undefined, and identifier set to uid.

Field Details

identifier

public String identifier


number

public int number

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.

Author:
Daniel F. Savarese

size

public int size

Constructor Details

POP3MessageInfo

public POP3MessageInfo()

Creates a POP3MessageInfo instance with number and size set to 0, and identifier set to null.


POP3MessageInfo

public POP3MessageInfo(int num, String uid)

Creates a POP3MessageInfo instance with number set to num , size undefined, and identifier set to uid.

Parameters:
num
uid

POP3MessageInfo

public POP3MessageInfo(int num, int octets)

Creates a POP3MessageInfo instance with number set to num , size set to octets , and identifier set to null.

Parameters:
num
octets