Skip navigation links

com.essbase.eas.ui.email
Class EmailRequestHelper

java.lang.Object
com.essbase.eas.ui.email.EmailRequestHelper

public class EmailRequestHelper

extends java.lang.Object

Method Summary

static boolean	isSMTPServerSet() Return whether or not the SMTP server value is set for the logged in user
static java.lang.String	requestEmailAddress() return the e-mail address used to send with an e-mail
static java.lang.String	requestEmailFullName() get the user's full name to use when sending an e-mail
static java.lang.String	requestEmailHost() return the SMTP server to use for sending e-mail
static void	requestSetEmailStatus(java.lang.String cmdName, java.lang.String message, boolean error) Simply registers that an email was sent from the client the cmdNames is put in the background process table and accessible from the Background Process Frame
static void	setEmailAddress(java.lang.String emailAddress) set the e-mail address for the Framework user
static void	setEmailFullName(java.lang.String fullName) set the e-mail name for the Framework user
static void	setEmailHost(java.lang.String host) Set the e-mail host to a new SMTP server.

Methods inherited from class java.lang.Object

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

Method Detail

requestEmailAddress

public static java.lang.String requestEmailAddress()

return the e-mail address used to send with an e-mail

Returns:

the e-mail address

setEmailAddress

public static void setEmailAddress(java.lang.String emailAddress)

set the e-mail address for the Framework user

Parameters:

emailAddress -

requestEmailFullName

public static java.lang.String requestEmailFullName()

get the user's full name to use when sending an e-mail

Returns:

the name

setEmailFullName

public static void setEmailFullName(java.lang.String fullName)

set the e-mail name for the Framework user

Parameters:

fullName -

requestEmailHost

public static java.lang.String requestEmailHost()

return the SMTP server to use for sending e-mail

Returns:

the host

setEmailHost

public static void setEmailHost(java.lang.String host)

Set the e-mail host to a new SMTP server. The host should be checked to make sure it is a valid SMTP server.

Parameters:

host -

requestSetEmailStatus

public static void requestSetEmailStatus(java.lang.String cmdName,
                                         java.lang.String message,
                                         boolean error)

Simply registers that an email was sent from the client the cmdNames is put in the background process table and accessible from the Background Process Frame

Parameters:

cmdName - some information about the command

message - the outcome of the

error - signals whether an error occurred while sending true if an error occurred false otherwise

isSMTPServerSet

public static boolean isSMTPServerSet()

Return whether or not the SMTP server value is set for the logged in user

Returns:

true if the SMTP server value is set false otherwise.

Skip navigation links