com.sun.slamd.scripting.mail
Class POPConnectionVariable

java.lang.Object
  com.sun.slamd.scripting.engine.Variable
      com.sun.slamd.scripting.mail.POPConnectionVariable

All Implemented Interfaces:

Argument

public class POPConnectionVariable

extends Variable

This class defines a variable that maintains a connection to a POP3 mail server and allows for interaction with that server. A POP connection has the the following methods:

• authenticate(string userID, string password) -- Authenticates to the POP3 server. This method returns a Boolean value indicating whether the authentication was successful.
• connect(string host, int port) -- Establishes a POP3 connection to the mail server. Returns a Boolean value indicating whether the connection was established successfully.
• connect(string host, int port, boolean useSSL) -- Establishes a POP3 connection to the mail server, optionally using SSL. Returns a Boolean value indicating whether the connection was established successfully.
• delete(int messageID) -- Attempts to delete the specified message from the POP3 server. This method returns a Boolean value indicating whether the delete was successful.
• disconnect() -- Closes the connection to the POP3 server. This method does not return a value.
• getFailureReason() -- Retrives a string that provides information about the reason for the last failure, if that is available.
• list() -- Retrieves a list of the messages contained in the user's inbox. This method returns a string array containing the lines of output from the list command.
• noOp() -- Sends a NOOP command to the server, which has no effect but to prevent the connection from remaining idle for too long. This method does not return a value.
• retrieve(int messageID) -- Retrieves the specified message from the user's inbox. The message will be returned as a mail message object.
• stat() -- Retrieves the number of messages contained in the user's inbox. This method will return an integer indicating the number of messages in the inbox.
• top(int messageID, int lines) -- Retrieves the indicated number of lines from the top of the specified message. This method will return a string array containing the requested lines.

Field Summary

static java.lang.String	AUTHENTICATE_METHOD_NAME The name of the method that performs a POP3 authentication.
static int	AUTHENTICATE_METHOD_NUMBER The method number for the "authenticate" method.
static int	CONNECT_1_METHOD_NUMBER The method number for the first "connect" method.
static int	CONNECT_2_METHOD_NUMBER The method number for the second "connect" method.
static java.lang.String	CONNECT_METHOD_NAME The name of the method that establishes a connection to the POP server.
static java.lang.String	DELETE_METHOD_NAME The name of the method that can be used to delete a message from the POP3 server.
static int	DELETE_METHOD_NUMBER The method number for the "delete" method.
static java.lang.String	DISCONNECT_METHOD_NAME The name of the method that can be used to disconnect from the POP3 server.
static int	DISCONNECT_METHOD_NUMBER The method number for the "disconnect" method.
static java.lang.String	EOL The end of line character as required by RFC 1725.
static java.lang.String	GET_FAILURE_REASON_METHOD_NAME The name of the method that can be used to determine the reason for the last failure.
static int	GET_FAILURE_REASON_METHOD_NUMBER The method number for the "getFailureReason" method.
static java.lang.String	LIST_METHOD_NAME The name of the method that can be used to list the messages in the POP3 server.
static int	LIST_METHOD_NUMBER The method number for the "list" method.
static java.lang.String	NOOP_METHOD_NAME The name of the method that sends a "NOOP" to the server.
static int	NOOP_METHOD_NUMBER The method number for the "noop" method.
static Method[]	POP_CONNECTION_VARIABLE_METHODS The set of methods associated with POP connection variables.
static java.lang.String	POP_CONNECTION_VARIABLE_TYPE The name that will be used for the data type of POP connection variables.
static java.lang.String	RETRIEVE_METHOD_NAME The name of the method that can be used to retrieve a message in the POP3 server.
static int	RETRIEVE_METHOD_NUMBER The method number for the "retrieve" method.
static java.lang.String	STAT_METHOD_NAME The name of the method that can be used to determine the number of messages in the user's inbox.
static int	STAT_METHOD_NUMBER The method number for the "stat" method.
static java.lang.String	TOP_METHOD_NAME The name of the method that can be used to retrieve the top portion of a mail message.
static int	TOP_METHOD_NUMBER The method number for the "top" method.

Constructor Summary

POPConnectionVariable()
Creates a new variable with no name, to be used only when creating a variable with Class.newInstance(), and only when setName() is called after that to set the name.

Method Summary

void	assign(Argument argument) Assigns the value of the provided argument to this variable.
Variable	executeMethod(int lineNumber, int methodNumber, Argument[] arguments) Executes the specified method, using the provided variables as arguments to the method, and makes the return value available to the caller.
int	getMethodNumber(java.lang.String methodName, java.lang.String[] argumentTypes) Retrieves the method number for the method that has the specified name and argument types, or -1 if there is no such method.
Method[]	getMethods() Retrieves a list of all methods defined for this variable.
java.lang.String	getReturnTypeForMethod(java.lang.String methodName, java.lang.String[] argumentTypes) Retrieves the return type for the method with the specified name and argument types.
java.lang.String	getValueAsString() Retrieves a string representation of the value of this argument.
java.lang.String	getVariableTypeName() Retrieves the name of the variable type for this variable.
boolean	hasMethod(java.lang.String methodName) Indicates whether this variable type has a method with the specified name.

Methods inherited from class com.sun.slamd.scripting.engine.Variable

getArgumentAsString, getArgumentType, getArgumentValue, getName, getStatTrackers, isValidIdentifier, setName, startStatTrackers, stopStatTrackers

Methods inherited from class java.lang.Object

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

Field Detail

POP_CONNECTION_VARIABLE_TYPE

public static final java.lang.String POP_CONNECTION_VARIABLE_TYPE

The name that will be used for the data type of POP connection variables.

See Also:

Constant Field Values

AUTHENTICATE_METHOD_NAME

public static final java.lang.String AUTHENTICATE_METHOD_NAME

The name of the method that performs a POP3 authentication.

See Also:

Constant Field Values

AUTHENTICATE_METHOD_NUMBER

public static final int AUTHENTICATE_METHOD_NUMBER

The method number for the "authenticate" method.

See Also:

Constant Field Values

CONNECT_METHOD_NAME

public static final java.lang.String CONNECT_METHOD_NAME

The name of the method that establishes a connection to the POP server.

See Also:

Constant Field Values

CONNECT_1_METHOD_NUMBER

public static final int CONNECT_1_METHOD_NUMBER

The method number for the first "connect" method.

See Also:

Constant Field Values

CONNECT_2_METHOD_NUMBER

public static final int CONNECT_2_METHOD_NUMBER

The method number for the second "connect" method.

See Also:

Constant Field Values

DELETE_METHOD_NAME

public static final java.lang.String DELETE_METHOD_NAME

The name of the method that can be used to delete a message from the POP3 server.

See Also:

Constant Field Values

DELETE_METHOD_NUMBER

public static final int DELETE_METHOD_NUMBER

The method number for the "delete" method.

See Also:

Constant Field Values

DISCONNECT_METHOD_NAME

public static final java.lang.String DISCONNECT_METHOD_NAME

The name of the method that can be used to disconnect from the POP3 server.

See Also:

Constant Field Values

DISCONNECT_METHOD_NUMBER

public static final int DISCONNECT_METHOD_NUMBER

The method number for the "disconnect" method.

See Also:

Constant Field Values

GET_FAILURE_REASON_METHOD_NAME

public static final java.lang.String GET_FAILURE_REASON_METHOD_NAME

The name of the method that can be used to determine the reason for the last failure.

See Also:

Constant Field Values

GET_FAILURE_REASON_METHOD_NUMBER

public static final int GET_FAILURE_REASON_METHOD_NUMBER

The method number for the "getFailureReason" method.

See Also:

Constant Field Values

LIST_METHOD_NAME

public static final java.lang.String LIST_METHOD_NAME

The name of the method that can be used to list the messages in the POP3 server.

See Also:

Constant Field Values

LIST_METHOD_NUMBER

public static final int LIST_METHOD_NUMBER

The method number for the "list" method.

See Also:

Constant Field Values

NOOP_METHOD_NAME

public static final java.lang.String NOOP_METHOD_NAME

The name of the method that sends a "NOOP" to the server.

See Also:

Constant Field Values

NOOP_METHOD_NUMBER

public static final int NOOP_METHOD_NUMBER

The method number for the "noop" method.

See Also:

Constant Field Values

RETRIEVE_METHOD_NAME

public static final java.lang.String RETRIEVE_METHOD_NAME

The name of the method that can be used to retrieve a message in the POP3 server.

See Also:

Constant Field Values

RETRIEVE_METHOD_NUMBER

public static final int RETRIEVE_METHOD_NUMBER

The method number for the "retrieve" method.

See Also:

Constant Field Values

STAT_METHOD_NAME

public static final java.lang.String STAT_METHOD_NAME

The name of the method that can be used to determine the number of messages in the user's inbox.

See Also:

Constant Field Values

STAT_METHOD_NUMBER

public static final int STAT_METHOD_NUMBER

The method number for the "stat" method.

See Also:

Constant Field Values

TOP_METHOD_NAME

public static final java.lang.String TOP_METHOD_NAME

The name of the method that can be used to retrieve the top portion of a mail message.

See Also:

Constant Field Values

TOP_METHOD_NUMBER

public static final int TOP_METHOD_NUMBER

The method number for the "top" method.

See Also:

Constant Field Values

POP_CONNECTION_VARIABLE_METHODS

public static final Method[] POP_CONNECTION_VARIABLE_METHODS

The set of methods associated with POP connection variables.

EOL

public static final java.lang.String EOL

The end of line character as required by RFC 1725.

See Also:

Constant Field Values

Constructor Detail

POPConnectionVariable

public POPConnectionVariable()
                      throws ScriptException

Creates a new variable with no name, to be used only when creating a variable with Class.newInstance(), and only when setName() is called after that to set the name.

Throws:

ScriptException - If a problem occurs while initializing the new variable.

Method Detail

getVariableTypeName

public java.lang.String getVariableTypeName()

Retrieves the name of the variable type for this variable.

Specified by:

getVariableTypeName in class Variable

Returns:

The name of the variable type for this variable.

getMethods

public Method[] getMethods()

Retrieves a list of all methods defined for this variable.

Specified by:

getMethods in class Variable

Returns:

A list of all methods defined for this variable.

hasMethod

public boolean hasMethod(java.lang.String methodName)

Indicates whether this variable type has a method with the specified name.

Specified by:

hasMethod in class Variable

Parameters:

methodName - The name of the method.

Returns:

true if this variable has a method with the specified name, or false if it does not.

getMethodNumber

public int getMethodNumber(java.lang.String methodName,
                           java.lang.String[] argumentTypes)

Retrieves the method number for the method that has the specified name and argument types, or -1 if there is no such method.

Specified by:

getMethodNumber in class Variable

Parameters:

methodName - The name of the method.

argumentTypes - The list of argument types for the method.

Returns:

The method number for the method that has the specified name and argument types.

getReturnTypeForMethod

public java.lang.String getReturnTypeForMethod(java.lang.String methodName,
                                               java.lang.String[] argumentTypes)

Retrieves the return type for the method with the specified name and argument types.

Specified by:

getReturnTypeForMethod in class Variable

Parameters:

methodName - The name of the method.

argumentTypes - The set of argument types for the method.

Returns:

The return type for the method, or null if there is no such method defined.

executeMethod

public Variable executeMethod(int lineNumber,
                              int methodNumber,
                              Argument[] arguments)
                       throws ScriptException

Executes the specified method, using the provided variables as arguments to the method, and makes the return value available to the caller.

Specified by:

executeMethod in class Variable

Parameters:

lineNumber - The line number of the script in which the method call occurs.

methodNumber - The method number of the method to execute.

arguments - The set of arguments to use for the method.

Returns:

The value returned from the method, or null if it does not return a value.

Throws:

ScriptException - If the specified method does not exist, or if a problem occurs while attempting to execute it.

assign

public void assign(Argument argument)
            throws ScriptException

Assigns the value of the provided argument to this variable. The value of the provided argument must be of the same type as this variable.

Specified by:

assign in class Variable

Parameters:

argument - The argument whose value should be assigned to this variable.

Throws:

ScriptException - If a problem occurs while performing the assignment.

getValueAsString

public java.lang.String getValueAsString()

Retrieves a string representation of the value of this argument.

Returns:

A string representation of the value of this argument.