com.alarexgroup.m2mplf.clients
Class POP3Client

java.lang.Object
  com.alarexgroup.m2mplf.clients.POP3Client

public class POP3Client
extends java.lang.Object

Constructor Summary

POP3Client(java.lang.String pop3Server, int port, java.lang.String connectionProfile)
Creates pop3Client ready to use.

Method Summary

void	close() Finishes POP3Cliet processing.
boolean	delete(int num) Erases message on server
java.lang.String	getMessage(int num) Returns String message
java.io.InputStream	getMessageAsStream(int num) Opens InputStream with recieved message.
int[][]	list() Dumps list of messages on server and their size in octets.
boolean	openPOP3(java.lang.String user, java.lang.String password) Executes login to POP3 server
java.lang.String	top(int num, int lines) Returns expected number of rows of message and his head.

Methods inherited from class java.lang.Object

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

Constructor Detail

POP3Client

public POP3Client(java.lang.String pop3Server,
                  int port,
                  java.lang.String connectionProfile)

Creates pop3Client ready to use.

Parameters:

pop3Server - server address, i.e.: pop3.google.com or is possible to use IP address

port - standard value 110

connectionProfile - GPRS profile or CSD connection

Method Detail

openPOP3

public boolean openPOP3(java.lang.String user,
                        java.lang.String password)

Executes login to POP3 server

Parameters:

user -

password -

Returns:

TRUE - Successful login FALSE - Unsuccessful login. Next information in log. file.

list

public int[][] list()

Dumps list of messages on server and their size in octets.

Returns:

List of messages in arrey. First index is row of list. Second index is 0 .. id. of message, 1 .. size of message.

getMessage

public java.lang.String getMessage(int num)

Returns String message

Parameters:

num - id. of message returned by LIST command.

Returns:

Message includes head, body and ends by mark .

getMessageAsStream

public java.io.InputStream getMessageAsStream(int num)

Opens InputStream with recieved message. This method is useful, if the message was big and processing could cause application fall - in consequence of memory lack. End of message is marked as CRLF.CRLF. Do not close InputStream by method close();

Parameters:

num - message id.

Returns:

Otevřený InputStream includes message.

top

public java.lang.String top(int num,
                            int lines)

Returns expected number of rows of message and his head. Is used i.e. to locate of data origin and message subject

Parameters:

num - message id.

lines -

Returns:

String with part of message

delete

public boolean delete(int num)

Erases message on server

Parameters:

num -

Returns:

TRUE - succes

close

public void close()

Finishes POP3Cliet processing.