com.sun.slamd.scripting.mail
Class SMTPConnectionVariable

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

All Implemented Interfaces:

Argument

public class SMTPConnectionVariable

extends Variable

This class defines a variable that maintains a connection to an SMTP mail server and allows for interaction with that server. An SMTP connection has the following methods:

• authCRAMMD5(string username, string password) -- Authenticates to the SMTP server using the CRAM-MD5 mechanism. Returns a Boolean value indicating whether the authentication was successful.
• authLogin(string username, string password) -- Authenticates to the SMTP server using the AUTH LOGIN mechanism. Returns a Boolean value indicating whether the authentication was successful.
• authPlain(string username, string password) -- Authenticates to the SMTP server using the AUTH PLAIN mechanism. Returns a Boolean value indicating whether the authentication was successful.
• connect(string host, int port) -- Establishes an SMTP connection to the mail server. Returns a Boolean value indicating whether the connection was established successfully.
• connect(string host, int port, boolean useSSL) -- Establishes an SMTP connection to the mail server, optionally using SSL. Returns a Boolean value indicating whether the connection was established successfully.
• disconnect() -- Closes the connection to the SMTP 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.
• 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.
• send(MailMessage message) -- Sends the provided mail message to the server. This method returns a Boolean value indicating whether the message was sent successfully.
• sendCommand(string command) -- Sends the specified command to the SMTP server and retrieves the response line from the server.

Field Summary

static java.lang.String	AUTH_CRAM_MD5_METHOD_NAME The name of the method that can be used to authenticate to the server using CRAM-MD5.
static int	AUTH_CRAM_MD5_METHOD_NUMBER The method number for the "authCRAMMD5" method.
static java.lang.String	AUTH_LOGIN_METHOD_NAME The name of the method that can be used to authenticate to the server using AUTH LOGIN.
static int	AUTH_LOGIN_METHOD_NUMBER The method number for the "authLogin" method.
static java.lang.String	AUTH_PLAIN_METHOD_NAME The name of the method that can be used to authenticate to the server using AUTH PLAIN.
static int	AUTH_PLAIN_METHOD_NUMBER The method number for the "authPlain" 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 can be used to establish a connection to an SMTP server.
static java.lang.String	DISCONNECT_METHOD_NAME The name of the method that can be used to disconnect from an SMTP 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 821.
static java.lang.String	GET_FAILURE_REASON_METHOD_NAME The name of the method that can be used to determine the reason that the last operation failed.
static int	GET_FAILURE_REASON_METHOD_NUMBER The method number for the "getFailureReason" 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 java.lang.String	SEND_COMMAND_METHOD_NAME The name of the method that can be used to send a raw SMTP command to the server.
static int	SEND_COMMAND_METHOD_NUMBER The method number for the "sendCommand" method.
static java.lang.String	SEND_METHOD_NAME The name of the method that can be used to send a message to the SMTP server.
static int	SEND_METHOD_NUMBER The method number for the "send" method.
static Method[]	SMTP_CONNECTION_VARIABLE_METHODS The set of methods associated with SMTP connection variables.
static java.lang.String	SMTP_CONNECTION_VARIABLE_TYPE The name that will be used for the data type of SMTP connection variables.

Constructor Summary

SMTPConnectionVariable()
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

SMTP_CONNECTION_VARIABLE_TYPE

public static final java.lang.String SMTP_CONNECTION_VARIABLE_TYPE

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

See Also:

Constant Field Values

AUTH_CRAM_MD5_METHOD_NAME

public static final java.lang.String AUTH_CRAM_MD5_METHOD_NAME

The name of the method that can be used to authenticate to the server using CRAM-MD5.

See Also:

Constant Field Values

AUTH_CRAM_MD5_METHOD_NUMBER

public static final int AUTH_CRAM_MD5_METHOD_NUMBER

The method number for the "authCRAMMD5" method.

See Also:

Constant Field Values

AUTH_LOGIN_METHOD_NAME

public static final java.lang.String AUTH_LOGIN_METHOD_NAME

The name of the method that can be used to authenticate to the server using AUTH LOGIN.

See Also:

Constant Field Values

AUTH_LOGIN_METHOD_NUMBER

public static final int AUTH_LOGIN_METHOD_NUMBER

The method number for the "authLogin" method.

See Also:

Constant Field Values

AUTH_PLAIN_METHOD_NAME

public static final java.lang.String AUTH_PLAIN_METHOD_NAME

The name of the method that can be used to authenticate to the server using AUTH PLAIN.

See Also:

Constant Field Values

AUTH_PLAIN_METHOD_NUMBER

public static final int AUTH_PLAIN_METHOD_NUMBER

The method number for the "authPlain" method.

See Also:

Constant Field Values

CONNECT_METHOD_NAME

public static final java.lang.String CONNECT_METHOD_NAME

The name of the method that can be used to establish a connection to an SMTP 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

DISCONNECT_METHOD_NAME

public static final java.lang.String DISCONNECT_METHOD_NAME

The name of the method that can be used to disconnect from an SMTP 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 that the last operation failed.

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

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

SEND_METHOD_NAME

public static final java.lang.String SEND_METHOD_NAME

The name of the method that can be used to send a message to the SMTP server.

See Also:

Constant Field Values

SEND_METHOD_NUMBER

public static final int SEND_METHOD_NUMBER

The method number for the "send" method.

See Also:

Constant Field Values

SEND_COMMAND_METHOD_NAME

public static final java.lang.String SEND_COMMAND_METHOD_NAME

The name of the method that can be used to send a raw SMTP command to the server.

See Also:

Constant Field Values

SEND_COMMAND_METHOD_NUMBER

public static final int SEND_COMMAND_METHOD_NUMBER

The method number for the "sendCommand" method.

See Also:

Constant Field Values

SMTP_CONNECTION_VARIABLE_METHODS

public static final Method[] SMTP_CONNECTION_VARIABLE_METHODS

The set of methods associated with SMTP connection variables.

EOL

public static final java.lang.String EOL

The end of line character as required by RFC 821.

See Also:

Constant Field Values

Constructor Detail

SMTPConnectionVariable

public SMTPConnectionVariable()
                       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.