Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * 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;
 
 import java.io.Reader;
 
The POP3Client class implements the client side of the Internet POP3 Protocol defined in RFC 1939. All commands are supported, including the APOP command which requires MD5 encryption. See RFC 1939 for more details on the POP3 protocol.

Rather than list it separately for each method, we mention here that every method communicating with the server and throwing an IOException can also throw a org.apache.commons.net.MalformedServerReplyException , which is a subclass of IOException. A MalformedServerReplyException will be thrown when the reply received from the server deviates enough from the protocol specification that it cannot be interpreted in a useful manner despite attempts to be as lenient as possible.

 
 
 public class POP3Client extends POP3
 {
 
     private static POP3MessageInfo __parseStatus(String line)
     {
         int numsize;
         StringTokenizer tokenizer;
 
         tokenizer = new StringTokenizer(line);
 
         if (!tokenizer.hasMoreElements()) {
             return null;
         }
 
         num = size = 0;
 
         try
         {
             num = Integer.parseInt(tokenizer.nextToken());
 
             if (!tokenizer.hasMoreElements()) {
                 return null;
             }
 
             size = Integer.parseInt(tokenizer.nextToken());
         }
         catch (NumberFormatException e)
         {
             return null;
         }
 
         return new POP3MessageInfo(numsize);
     }
 
     private static POP3MessageInfo __parseUID(String line)
     {
         int num;
         StringTokenizer tokenizer;
 
         tokenizer = new StringTokenizer(line);
 
         if (!tokenizer.hasMoreElements()) {
             return null;
         }
 
         num = 0;
 
         try
         {
            num = Integer.parseInt(tokenizer.nextToken());
            if (!tokenizer.hasMoreElements()) {
                return null;
            }
            line = tokenizer.nextToken();
        }
        catch (NumberFormatException e)
        {
            return null;
        }
        return new POP3MessageInfo(numline);
    }

    
Send a CAPA command to the POP3 server.

Returns:
True if the command was successful, false if not.
Throws:
java.io.IOException If a network I/O error occurs in the process of sending the CAPA command.
Since:
3.1 (was previously in ExtendedPOP3Client)
    public boolean capa() throws IOException
    {
        if (sendCommand(.) == .) {
            getAdditionalReply();
            return true;
        }
        return false;
    }

    
Login to the POP3 server with the given username and password. You must first connect to the server with connect before attempting to login. A login attempt is only valid if the client is in the AUTHORIZATION_STATE . After logging in, the client enters the TRANSACTION_STATE .

Parameters:
username The account name being logged in to.
password The plain text password of the account.
Returns:
True if the login attempt was successful, false if not.
Throws:
java.io.IOException If a network I/O error occurs in the process of logging in.
    public boolean login(String usernameString passwordthrows IOException
    {
        if (getState() != ) {
            return false;
        }
        if (sendCommand(.username) != .) {
            return false;
        }
        if (sendCommand(.password) != .) {
            return false;
        }
        setState();
        return true;
    }


    
Login to the POP3 server with the given username and authentication information. Use this method when connecting to a server requiring authentication using the APOP command. Because the timestamp produced in the greeting banner varies from server to server, it is not possible to consistently extract the information. Therefore, after connecting to the server, you must call getReplyString and parse out the timestamp information yourself.

You must first connect to the server with connect before attempting to login. A login attempt is only valid if the client is in the AUTHORIZATION_STATE . After logging in, the client enters the TRANSACTION_STATE . After connecting, you must parse out the server specific information to use as a timestamp, and pass that information to this method. The secret is a shared secret known to you and the server. See RFC 1939 for more details regarding the APOP command.

Parameters:
username The account name being logged in to.
timestamp The timestamp string to combine with the secret.
secret The shared secret which produces the MD5 digest when combined with the timestamp.
Returns:
True if the login attempt was successful, false if not.
Throws:
java.io.IOException If a network I/O error occurs in the process of logging in.
java.security.NoSuchAlgorithmException If the MD5 encryption algorithm cannot be instantiated by the Java runtime system.
    public boolean login(String usernameString timestampString secret)
    {
        int i;
        byte[] digest;
        StringBuilder bufferdigestBuffer;
        MessageDigest md5;
        if (getState() != ) {
            return false;
        }
        md5 = MessageDigest.getInstance("MD5");
        timestamp += secret;
        digest = md5.digest(timestamp.getBytes(getCharsetName())); // Java 1.6 can use getCharset()
        digestBuffer = new StringBuilder(128);
        for (i = 0; i < digest.lengthi++) {
            int digit = digest[i] & 0xff;
            if (digit <= 15) { // Add leading zero if necessary (NET-351)
                digestBuffer.append("0");
            }
            digestBuffer.append(Integer.toHexString(digit));
        }
        buffer = new StringBuilder(256);
        buffer.append(username);
        buffer.append(' ');
        buffer.append(digestBuffer.toString());
        if (sendCommand(.buffer.toString()) != .) {
            return false;
        }
        setState();
        return true;
    }


    
Logout of the POP3 server. To fully disconnect from the server you must call disconnect . A logout attempt is valid in any state. If the client is in the TRANSACTION_STATE , it enters the UPDATE_STATE on a successful logout.

Returns:
True if the logout attempt was successful, false if not.
Throws:
java.io.IOException If a network I/O error occurs in the process of logging out.
    public boolean logout() throws IOException
    {
        if (getState() == ) {
            setState();
        }
        sendCommand(.);
        return ( == .);
    }


    
Send a NOOP command to the POP3 server. This is useful for keeping a connection alive since most POP3 servers will timeout after 10 minutes of inactivity. A noop attempt will only succeed if the client is in the TRANSACTION_STATE .

Returns:
True if the noop attempt was successful, false if not.
Throws:
java.io.IOException If a network I/O error occurs in the process of sending the NOOP command.
    public boolean noop() throws IOException
    {
        if (getState() == ) {
            return (sendCommand(.) == .);
        }
        return false;
    }


    
Delete a message from the POP3 server. The message is only marked for deletion by the server. If you decide to unmark the message, you must issuse a reset command. Messages marked for deletion are only deleted by the server on logout . A delete attempt can only succeed if the client is in the TRANSACTION_STATE .

Parameters:
messageId The message number to delete.
Returns:
True if the deletion attempt was successful, false if not.
Throws:
java.io.IOException If a network I/O error occurs in the process of sending the delete command.
    public boolean deleteMessage(int messageIdthrows IOException
    {
        if (getState() == ) {
            return (sendCommand(., Integer.toString(messageId))
                    == .);
        }
        return false;
    }


    
Reset the POP3 session. This is useful for undoing any message deletions that may have been performed. A reset attempt can only succeed if the client is in the TRANSACTION_STATE .

Returns:
True if the reset attempt was successful, false if not.
Throws:
java.io.IOException If a network I/O error occurs in the process of sending the reset command.
    public boolean reset() throws IOException
    {
        if (getState() == ) {
            return (sendCommand(.) == .);
        }
        return false;
    }

    
Get the mailbox status. A status attempt can only succeed if the client is in the TRANSACTION_STATE . Returns a POP3MessageInfo instance containing the number of messages in the mailbox and the total size of the messages in bytes. Returns null if the status the attempt fails.

Returns:
A POP3MessageInfo instance containing the number of messages in the mailbox and the total size of the messages in bytes. Returns null if the status the attempt fails.
Throws:
java.io.IOException If a network I/O error occurs in the process of sending the status command.
    public POP3MessageInfo status() throws IOException
    {
        if (getState() != ) {
            return null;
        }
        if (sendCommand(.) != .) {
            return null;
        }
        return __parseStatus(.substring(3));
    }


    
List an individual message. A list attempt can only succeed if the client is in the TRANSACTION_STATE . Returns a POP3MessageInfo instance containing the number of the listed message and the size of the message in bytes. Returns null if the list attempt fails (e.g., if the specified message number does not exist).

Parameters:
messageId The number of the message list.
Returns:
A POP3MessageInfo instance containing the number of the listed message and the size of the message in bytes. Returns null if the list attempt fails.
Throws:
java.io.IOException If a network I/O error occurs in the process of sending the list command.
    public POP3MessageInfo listMessage(int messageIdthrows IOException
    {
        if (getState() != ) {
            return null;
        }
        if (sendCommand(., Integer.toString(messageId))
                != .) {
            return null;
        }
        return __parseStatus(.substring(3));
    }


    
List all messages. A list attempt can only succeed if the client is in the TRANSACTION_STATE . Returns an array of POP3MessageInfo instances, each containing the number of a message and its size in bytes. If there are no messages, this method returns a zero length array. If the list attempt fails, it returns null.

Returns:
An array of POP3MessageInfo instances representing all messages in the order they appear in the mailbox, each containing the number of a message and its size in bytes. If there are no messages, this method returns a zero length array. If the list attempt fails, it returns null.
Throws:
java.io.IOException If a network I/O error occurs in the process of sending the list command.
    public POP3MessageInfo[] listMessages() throws IOException
    {
        if (getState() != ) {
            return null;
        }
        if (sendCommand(.) != .) {
            return null;
        }
        getAdditionalReply();
        // This could be a zero length array if no messages present
        POP3MessageInfo[] messages = new POP3MessageInfo[.size() - 2]; // skip first and last lines
        ListIterator<Stringen = .listIterator(1); // Skip first line
        // Fetch lines.
        for (int line = 0; line < messages.lengthline++) {
            messages[line] = __parseStatus(en.next());
        }
        return messages;
    }

    
List the unique identifier for a message. A list attempt can only succeed if the client is in the TRANSACTION_STATE . Returns a POP3MessageInfo instance containing the number of the listed message and the unique identifier for that message. Returns null if the list attempt fails (e.g., if the specified message number does not exist).

Parameters:
messageId The number of the message list.
Returns:
A POP3MessageInfo instance containing the number of the listed message and the unique identifier for that message. Returns null if the list attempt fails.
Throws:
java.io.IOException If a network I/O error occurs in the process of sending the list unique identifier command.
    public POP3MessageInfo listUniqueIdentifier(int messageId)
    throws IOException
    {
        if (getState() != ) {
            return null;
        }
        if (sendCommand(., Integer.toString(messageId))
                != .) {
            return null;
        }
        return __parseUID(.substring(3));
    }


    
List the unique identifiers for all messages. A list attempt can only succeed if the client is in the TRANSACTION_STATE . Returns an array of POP3MessageInfo instances, each containing the number of a message and its unique identifier. If there are no messages, this method returns a zero length array. If the list attempt fails, it returns null.

Returns:
An array of POP3MessageInfo instances representing all messages in the order they appear in the mailbox, each containing the number of a message and its unique identifier If there are no messages, this method returns a zero length array. If the list attempt fails, it returns null.
Throws:
java.io.IOException If a network I/O error occurs in the process of sending the list unique identifier command.
    {
        if (getState() != ) {
            return null;
        }
        if (sendCommand(.) != .) {
            return null;
        }
        getAdditionalReply();
        // This could be a zero length array if no messages present
        POP3MessageInfo[] messages = new POP3MessageInfo[.size() - 2]; // skip first and last lines
        ListIterator<Stringen = .listIterator(1); // skip first line
        // Fetch lines.
        for (int line = 0; line < messages.lengthline++) {
            messages[line] = __parseUID(en.next());
        }
        return messages;
    }


    
Retrieve a message from the POP3 server. A retrieve message attempt can only succeed if the client is in the TRANSACTION_STATE

You must not issue any commands to the POP3 server (i.e., call any other methods) until you finish reading the message from the returned BufferedReader instance. The POP3 protocol uses the same stream for issuing commands as it does for returning results. Therefore the returned BufferedReader actually reads directly from the POP3 connection. After the end of message has been reached, new commands can be executed and their replies read. If you do not follow these requirements, your program will not work properly.

Parameters:
messageId The number of the message to fetch.
Returns:
A DotTerminatedMessageReader instance from which the entire message can be read. This can safely be cast to a BufferedReader in order to use the BufferedReader.readLine() method. Returns null if the retrieval attempt fails (e.g., if the specified message number does not exist).
Throws:
java.io.IOException If a network I/O error occurs in the process of sending the retrieve message command.
    public Reader retrieveMessage(int messageIdthrows IOException
    {
        if (getState() != ) {
            return null;
        }
        if (sendCommand(., Integer.toString(messageId)) != .) {
            return null;
        }
        return new DotTerminatedMessageReader();
    }


    
Retrieve only the specified top number of lines of a message from the POP3 server. A retrieve top lines attempt can only succeed if the client is in the TRANSACTION_STATE

You must not issue any commands to the POP3 server (i.e., call any other methods) until you finish reading the message from the returned BufferedReader instance. The POP3 protocol uses the same stream for issuing commands as it does for returning results. Therefore the returned BufferedReader actually reads directly from the POP3 connection. After the end of message has been reached, new commands can be executed and their replies read. If you do not follow these requirements, your program will not work properly.

Parameters:
messageId The number of the message to fetch.
numLines The top number of lines to fetch. This must be >= 0.
Returns:
A DotTerminatedMessageReader instance from which the specified top number of lines of the message can be read. This can safely be cast to a BufferedReader in order to use the BufferedReader.readLine() method. Returns null if the retrieval attempt fails (e.g., if the specified message number does not exist).
Throws:
java.io.IOException If a network I/O error occurs in the process of sending the top command.
    public Reader retrieveMessageTop(int messageIdint numLines)
    throws IOException
    {
        if (numLines < 0 || getState() != ) {
            return null;
        }
        if (sendCommand(., Integer.toString(messageId) + " " +
                        Integer.toString(numLines)) != .) {
            return null;
        }
        return new DotTerminatedMessageReader();
    }
New to GrepCode? Check out our FAQ X