Class POP3

java.lang.Object

javaforce.POP3

public class POP3
extends Object

POP3 client class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	POP3.Message

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTH_APOP
static final String	AUTH_LOGIN
static boolean	debug
static boolean	debug_log
static int	log
static final int	PORT
String	response	Holds the response strings from the last executed command
static final int	SSLPORT
static final int	TLSPORT

Constructor Summary

Constructors

Constructor	Description
POP3()

Method Summary

Modifier and Type	Method	Description
boolean	auth(String user, String pass)	Authenticates with POP3 Server using AUTH_LOGIN type.
boolean	auth(String user, String pass, String type)	Authenticates with POP3 Server using APOP.
void	cmd(String cmd)	Send any command to server.
boolean	connect(String host, int port)	Connects to an insecure POP3 server.
boolean	connectSSL(String host, int port)	Connects to a secure POP3 server.
boolean	delete(int idx)	Delete message on server.
void	disconnect()	Disconnect from POP3 Server.
byte[]	get(int idx)	Get message
void	get(int idx, OutputStream os)	Get message
POP3.Message[]	list()	List messages available.
boolean	login()	Sends HELO command.
void	logout()	Send QUIT command.
static void	setLog(int id)
static void	setLogging(boolean state)	Set debug logging state.
void	starttls()	Secures connection using STARTTLS command.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

debug

public static boolean debug

debug_log

public static boolean debug_log

log

public static int log

response

public String response

Holds the response strings from the last executed command

PORT

public static final int PORT

See Also:

• Constant Field Values

TLSPORT

public static final int TLSPORT

See Also:

• Constant Field Values

SSLPORT

public static final int SSLPORT

See Also:

• Constant Field Values

AUTH_LOGIN

public static final String AUTH_LOGIN

See Also:

• Constant Field Values

AUTH_APOP

public static final String AUTH_APOP

See Also:

• Constant Field Values

Constructor Details

POP3

public POP3()

Method Details

connect

public boolean connect(String host,
 int port)
                throws Exception

Connects to an insecure POP3 server.

Parameters:

host - = POP3 server

port - = port to connect (default = 25 or 587)

Throws:

Exception

connectSSL

public boolean connectSSL(String host,
 int port)
                   throws Exception

Connects to a secure POP3 server.

Parameters:

host - = POP3 server

port - = port to connect (default = 465)

Throws:

Exception

disconnect

public void disconnect()
                throws Exception

Disconnect from POP3 Server.

Throws:

Exception

setLogging

public static void setLogging(boolean state)

Set debug logging state.

setLog

public static void setLog(int id)

login

public boolean login()
              throws Exception

Sends HELO command.

Throws:

Exception

auth

public boolean auth(String user,
 String pass,
 String type)
             throws Exception

Authenticates with POP3 Server using APOP.

Parameters:

user - = username

pass - = password

type - = AUTH_LOGIN or AUTH_APOP

Throws:

Exception

auth

public boolean auth(String user,
 String pass)
             throws Exception

Authenticates with POP3 Server using AUTH_LOGIN type.

Parameters:

user - = username

pass - = password

Throws:

Exception

logout

public void logout()
            throws Exception

Send QUIT command.

Throws:

Exception

cmd

public void cmd(String cmd)
         throws Exception

Send any command to server.

Throws:

Exception

starttls

public void starttls()
              throws Exception

Secures connection using STARTTLS command.

Throws:

Exception

list

public POP3.Message[] list()
                    throws Exception

List messages available.

Throws:

Exception

get

public byte[] get(int idx)
           throws Exception

Get message

Throws:

Exception

get

public void get(int idx,
 OutputStream os)
         throws Exception

Get message

Throws:

Exception

delete

public boolean delete(int idx)
               throws Exception

Delete message on server.

Throws:

Exception