filenet.vw.api

Class VWNotificationSettings

java.lang.Object

filenet.vw.api.VWNotificationSettings

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public final class VWNotificationSettings
extends java.lang.Object
implements java.io.Externalizable

This class encapsulates the definition of e-mail notification settings used by the PE server.

Since:

PE 5.2.0.0

See Also:

VWSystemAdministration.getNotificationSettings(), Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	getAllowLocalSMTPSettings() Gets the 'allow local SMTP settings' flag.
java.lang.String	getEMailFromId() Gets the e-mail 'From:' ID.
java.lang.String	getEMailLogonId() Gets the e-mail logon ID.
boolean	getEncodeFromField() Gets the 'encode from field' flag.
java.lang.String	getSMTPHostName() Gets the SMTP host name.
int	getSMTPPort() Gets the SMTP port number.
java.lang.String	getTLSProtocols() TlS protocols uses for the email.
void	setAllowLocalSMTPSettings(boolean bAllowLocalSmtpSettings) Sets the 'allow local SMTP settings' flag.
void	setEMailFromId(java.lang.String theEMailFromId) Sets the e-mail 'From:' ID.
void	setEMailLogonId(java.lang.String theEMailLogonId) Sets the e-mail logon ID.
void	setEMailPassword(java.lang.String theEMailPassword) Sets the e-mail password.
void	setEncodeFromField(boolean bEncodeFromField) Sets the 'encode from field' flag.
void	setSMTPHostName(java.lang.String theSmtpHostName) Sets the SMTP host name.
void	setSMTPPort(int theSmtpPort) Sets the SMTP port number.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Method Detail

getTLSProtocols

public java.lang.String getTLSProtocols()

TlS protocols uses for the email. In most cases the value is null, if default taken. If CPE server sets the flag (-D) filenet.mail.smtp.protocols, email will use this value Example: -Dfilenet.mail.smtp.protocols=TLSv1.2

Returns:

the tls protocols. Null means the default will be used.

Throws:

VWException

Since:

CPE 5.5.10.4

getSMTPHostName

public java.lang.String getSMTPHostName()
                                 throws VWException

Gets the SMTP host name.

Returns:

The SMTP host name.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

VWNotificationSettings.setSMTPHostName(String)

setSMTPHostName

public void setSMTPHostName(java.lang.String theSmtpHostName)
                     throws VWException

Sets the SMTP host name.

Parameters:

theSmtpHostName - The SMTP host name.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

getSMTPPort

public int getSMTPPort()
                throws VWException

Gets the SMTP port number.

Returns:

The SMTP port number.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

VWNotificationSettings.setSMTPPort(int)

setSMTPPort

public void setSMTPPort(int theSmtpPort)
                 throws VWException

Sets the SMTP port number.

Parameters:

theSmtpPort - The SMTP port number.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

getEMailLogonId

public java.lang.String getEMailLogonId()
                                 throws VWException

Gets the e-mail logon ID.

Returns:

The e-mail logon ID.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

VWNotificationSettings.setEMailLogonId(String)

setEMailLogonId

public void setEMailLogonId(java.lang.String theEMailLogonId)
                     throws VWException

Sets the e-mail logon ID.

Parameters:

theEMailLogonId - The e-mail logon ID.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

setEMailPassword

public void setEMailPassword(java.lang.String theEMailPassword)
                      throws VWException

Sets the e-mail password.

Parameters:

theEMailPassword - The e-mail password.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

getEMailFromId

public java.lang.String getEMailFromId()
                                throws VWException

Gets the e-mail 'From:' ID.

Returns:

The e-mail 'From:' ID.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

VWNotificationSettings.setEMailFromId(String)

setEMailFromId

public void setEMailFromId(java.lang.String theEMailFromId)
                    throws VWException

Sets the e-mail 'From:' ID.

Parameters:

theEMailFromId - The e-mail 'From:' ID.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

getEncodeFromField

public boolean getEncodeFromField()
                           throws VWException

Gets the 'encode from field' flag.

Returns:

The 'encode from field' flag.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

See Also:

VWNotificationSettings.setEncodeFromField(boolean)

setEncodeFromField

public void setEncodeFromField(boolean bEncodeFromField)
                        throws VWException

Sets the 'encode from field' flag.

Parameters:

bEncodeFromField - The 'encode from field' flag.

Throws:

VWException - Thrown for various causes.

Since:

PE 5.2.0.0

getAllowLocalSMTPSettings

public boolean getAllowLocalSMTPSettings()
                                  throws VWException

Gets the 'allow local SMTP settings' flag.

Returns:

The 'allow local SMTP settings' flag value.

Throws:

VWException - Thrown for various causes.

Since:

CPE 5.2.1.0

setAllowLocalSMTPSettings

public void setAllowLocalSMTPSettings(boolean bAllowLocalSmtpSettings)
                               throws VWException

Sets the 'allow local SMTP settings' flag.

Parameters:

bAllowLocalSmtpSettings - Specify true to allow specification of 'local' notification settings. If false, the GCD settings will be used.

Throws:

VWException - Thrown for various causes.

Since:

CPE 5.2.1.0