Quadcap Embeddable Server

com.quadcap.pop3.client.UidlEntry Class Reference

Inheritance diagram for com.quadcap.pop3.client.UidlEntry:

List of all members.

---

Detailed Description

This class holds a single UIDL entry in the Pop3 agent's UIDL map.

Each entry corresponds to a message on the server -- we'll rememember the date we first saw the message, so we can know when to delete it.

Author:

Stan Bailes

Definition at line 50 of file UidlEntry.java.

Public Member Functions
	UidlEntry (String uidl, int messageNumber, Date firstSeen)
	Construct a new UidlEntry from the specified parameters.
	UidlEntry (String s)
String	getUidl ()
	Get the uidl string.
int	getMessageNumber ()
	Get the POP3 message number.
void	setMessageNumber (int num)
	Set the POP3 message number.
Date	getFirstSeen ()
	Get the date this message was first seen.
String	toString ()
	Return a human-readable version of this UidlEntry object.
Public Attributes
transient boolean	markedForDeletion = false
Package Attributes
String	uidl
int	messageNumber
Date	firstSeen

---

Constructor & Destructor Documentation

com.quadcap.pop3.client.UidlEntry.UidlEntry (  String  uidl, int  messageNumber, Date  firstSeen )

Construct a new UidlEntry from the specified parameters. Parameters: uidl  the POP3 UIDL string returned from the server. messageNumber  the POP# message number returned from the server. firstSeen  the date when this message was first seen, usually the date when the UidlEntry object for that message is first constructed, i.e. 'now'. Definition at line 66 of file UidlEntry.java.

com.quadcap.pop3.client.UidlEntry.UidlEntry (  String  s  )

Definition at line 72 of file UidlEntry.java.

---

Member Function Documentation

Date com.quadcap.pop3.client.UidlEntry.getFirstSeen (   )

Get the date this message was first seen. Returns: the first seen date. Definition at line 111 of file UidlEntry.java. References com.quadcap.pop3.client.UidlEntry.firstSeen. Referenced by com.quadcap.pop3.client.Pop3Agent.getMail().

int com.quadcap.pop3.client.UidlEntry.getMessageNumber (   )

Get the POP3 message number. Returns: the POP3 message number, returned e.g. by the LIST command. Definition at line 95 of file UidlEntry.java. References com.quadcap.pop3.client.UidlEntry.messageNumber. Referenced by com.quadcap.pop3.client.Pop3Agent.deleteMessages(), and com.quadcap.pop3.client.Pop3Agent.getMessages().

String com.quadcap.pop3.client.UidlEntry.getUidl (   )

Get the uidl string. Returns: the uidl string for this message. Definition at line 87 of file UidlEntry.java. References com.quadcap.pop3.client.UidlEntry.uidl. Referenced by com.quadcap.pop3.client.Pop3Agent.deleteMessages(), and com.quadcap.pop3.client.Pop3Agent.read().

void com.quadcap.pop3.client.UidlEntry.setMessageNumber (  int  num  )

Set the POP3 message number. Parameters: num  the new POP3 message number. This is set in subsequent sessions, where a message has the same UIDL, but due to intervening deletions has a new message number. Definition at line 104 of file UidlEntry.java. References com.quadcap.pop3.client.UidlEntry.messageNumber, and com.quadcap.pop3.client.UidlEntry.setMessageNumber(). Referenced by com.quadcap.pop3.client.Pop3Agent.getMail(), and com.quadcap.pop3.client.UidlEntry.setMessageNumber().

String com.quadcap.pop3.client.UidlEntry.toString (   )

Return a human-readable version of this UidlEntry object. Returns: a string representing this UidlEntry Definition at line 118 of file UidlEntry.java. References com.quadcap.pop3.client.UidlEntry.firstSeen, and com.quadcap.pop3.client.UidlEntry.uidl. Referenced by com.quadcap.pop3.client.Pop3Agent.write().

---

Member Data Documentation

Date com.quadcap.pop3.client.UidlEntry.firstSeen [package]

Definition at line 53 of file UidlEntry.java. Referenced by com.quadcap.pop3.client.UidlEntry.getFirstSeen(), and com.quadcap.pop3.client.UidlEntry.toString().

transient boolean com.quadcap.pop3.client.UidlEntry.markedForDeletion = false

Definition at line 55 of file UidlEntry.java. Referenced by com.quadcap.pop3.client.Pop3Agent.getMail(), and com.quadcap.pop3.client.Pop3Agent.getMessages().

int com.quadcap.pop3.client.UidlEntry.messageNumber [package]

Definition at line 52 of file UidlEntry.java. Referenced by com.quadcap.pop3.client.UidlEntry.getMessageNumber(), and com.quadcap.pop3.client.UidlEntry.setMessageNumber().

String com.quadcap.pop3.client.UidlEntry.uidl [package]

Definition at line 51 of file UidlEntry.java. Referenced by com.quadcap.pop3.client.UidlEntry.getUidl(), and com.quadcap.pop3.client.UidlEntry.toString().