com.esri.gpt.framework.mail
Class MailConfiguration

java.lang.Object
  com.esri.gpt.framework.context.Configuration
      com.esri.gpt.framework.mail.MailConfiguration

public class MailConfiguration
extends Configuration

Mail configuration information.

Constructor Summary

MailConfiguration()
Default constructor.

Method Summary

String	getEmailAddressRegexp() Gets the regular expression used to validate an E-Mail address.
String	getIncomingToAddress() Gets the to E-Mail address for incoming mail.
String	getOutgoingFromAddress() Gets the from E-Mail address for outgoing mail.
PasswordAuthentication	getPasswordAuthentication() Gets the credentials used for password authentication (SMPT_AUTH).
String	getSmtpHost() Gets the SMTP host.
int	getSmtpPort() Gets the SMTP port.
MailRequest	newInboundRequest() Instantiates a new in-bound mail request The SMTP host and port are set, the to E-mail address is set.
MailRequest	newOutboundRequest() Instantiates a new out-bound mail request The SMTP host and port are set, the to E-mail address is set.
void	put(String smtpHost, String smtpPort, String outgoingFromAddress, String incomingToAddress) Puts configuration values.
void	setEmailAddressRegexp(String regexp) Sets the regular expression used to validate an E-Mail address.
void	setIncomingToAddress(String incomingToAddress) Sets the to E-Mail address for incoming mail.
void	setOutgoingFromAddress(String outgoingFromAddress) Sets the from E-Mail address for outgoing mail.
void	setPasswordAuthentication(PasswordAuthentication credentials) Sets the credentials used for password authentication (SMPT_AUTH).
void	setSmtpHost(String smtpHost) Sets the SMPT host.
void	setSmtpPort(int smtpPort) Sets the SMTP port.
String	toString() Returns the string representation of the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailConfiguration

public MailConfiguration()

Default constructor.

Method Detail

getEmailAddressRegexp

public String getEmailAddressRegexp()

Gets the regular expression used to validate an E-Mail address.

Returns:

the address validation regular expression

setEmailAddressRegexp

public void setEmailAddressRegexp(String regexp)

Sets the regular expression used to validate an E-Mail address.

Parameters:

regexp - the address validation regular expression

getIncomingToAddress

public String getIncomingToAddress()

Gets the to E-Mail address for incoming mail.

Returns:

the to address

setIncomingToAddress

public void setIncomingToAddress(String incomingToAddress)

Sets the to E-Mail address for incoming mail.

Parameters:

incomingToAddress - the to address for incoming mail

getOutgoingFromAddress

public String getOutgoingFromAddress()

Gets the from E-Mail address for outgoing mail.

Returns:

the from address

setOutgoingFromAddress

public void setOutgoingFromAddress(String outgoingFromAddress)

Sets the from E-Mail address for outgoing mail.

Parameters:

outgoingFromAddress - the from address for outgoing mail

getPasswordAuthentication

public PasswordAuthentication getPasswordAuthentication()

Gets the credentials used for password authentication (SMPT_AUTH).

Returns:

the credentials user for password authentication

setPasswordAuthentication

public void setPasswordAuthentication(PasswordAuthentication credentials)

Sets the credentials used for password authentication (SMPT_AUTH).

Parameters:

credentials - the credentials user for password authentication

getSmtpHost

public String getSmtpHost()

Gets the SMTP host.

Returns:

the SMTP host

setSmtpHost

public void setSmtpHost(String smtpHost)

Sets the SMPT host.

Parameters:

smtpHost - the SMPT host

getSmtpPort

public int getSmtpPort()

Gets the SMTP port.

Returns:

the SMTP port

setSmtpPort

public void setSmtpPort(int smtpPort)

Sets the SMTP port.

Parameters:

smtpPort - the SMTP port

newInboundRequest

public MailRequest newInboundRequest()

Instantiates a new in-bound mail request
The SMTP host and port are set, the to E-mail address is set.

Returns:

the mail request

newOutboundRequest

public MailRequest newOutboundRequest()

Instantiates a new out-bound mail request
The SMTP host and port are set, the to E-mail address is set.

Returns:

the mail request

put

public void put(String smtpHost,
                String smtpPort,
                String outgoingFromAddress,
                String incomingToAddress)

Puts configuration values.

Parameters:

smtpPort - the SMPT port

smtpHost - the SMPT host

outgoingFromAddress - the from address for outgoing mail

incomingToAddress - the to address for incoming mail

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class Object

Returns:

the string