Quadcap Embeddable Server

com/quadcap/pop3/client/UidlEntry.java

Go to the documentation of this file.

package com.quadcap.pop3.client;

/* Copyright 1997 - 2003 Quadcap Software.  All rights reserved.
 *
 * This software is distributed under the Quadcap Free Software License.
 * This software may be used or modified for any purpose, personal or
 * commercial.  Open Source redistributions are permitted.  Commercial
 * redistribution of larger works derived from, or works which bundle
 * this software requires a "Commercial Redistribution License"; see
 * http://www.quadcap.com/purchase.
 *
 * Redistributions qualify as "Open Source" under  one of the following terms:
 *   
 *    Redistributions are made at no charge beyond the reasonable cost of
 *    materials and delivery.
 *
 *    Redistributions are accompanied by a copy of the Source Code or by an
 *    irrevocable offer to provide a copy of the Source Code for up to three
 *    years at the cost of materials and delivery.  Such redistributions
 *    must allow further use, modification, and redistribution of the Source
 *    Code under substantially the same terms as this license.
 *
 * Redistributions of source code must retain the copyright notices as they
 * appear in each source code file, these license terms, and the
 * disclaimer/limitation of liability set forth as paragraph 6 below.
 *
 * Redistributions in binary form must reproduce this Copyright Notice,
 * these license terms, and the disclaimer/limitation of liability set
 * forth as paragraph 6 below, in the documentation and/or other materials
 * provided with the distribution.
 *
 * The Software is provided on an "AS IS" basis.  No warranty is
 * provided that the Software is free of defects, or fit for a
 * particular purpose.  
 *
 * Limitation of Liability. Quadcap Software shall not be liable
 * for any damages suffered by the Licensee or any third party resulting
 * from use of the Software.
 */

import java.util.Date;

/**
 * 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
 */
    String                      uidl;
    int                         messageNumber;
    Date                        firstSeen;
    
    transient public boolean    markedForDeletion = false;

    /**
     * Construct a new UidlEntry from the specified parameters.
     *
     * @param uidl the POP3 <b>UIDL</b> string returned from the server.
     * @param messageNumber the POP# message number returned from the server.
     * @param 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'.
     */
    public UidlEntry(String uidl, int messageNumber, Date firstSeen) {
        this.uidl = uidl;
        this.messageNumber = messageNumber;
        this.firstSeen = firstSeen;
    }

    public UidlEntry(String s) {
        int idx = s.indexOf(' ');
        if (idx < 0) {
            throw new RuntimeException("Bad UidlEntry string: " + s);
        }
        this.uidl = s.substring(0, idx);
        this.firstSeen = new Date(Long.parseLong(s.substring(idx+1)));
        this.messageNumber = -1;
    }

    /**
     * Get the uidl string.
     *
     * @return the uidl string for this message.
     */
    public String getUidl() { return uidl; }
    

    /**
     * Get the POP3 message number
     *
     * @return the POP3 message number, returned e.g. by the LIST command.
     */
    public int getMessageNumber() { return messageNumber; }

    /**
     * Set the POP3 message number.
     *
     * @param 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.
     */
    public void setMessageNumber(int num) { messageNumber = num; }

    /**
     * Get the date this message was first seen.
     *
     * @return the first seen date.
     */
    public Date getFirstSeen() { return firstSeen; }

    /**
     * Return a human-readable version of this UidlEntry object.
     *
     * @return a string representing this UidlEntry
     */
    public String toString() {
        return "" + uidl + " " + firstSeen.getTime();
    }
}