InternalEmailSettings

Method Summary
Data	getData() Returns EmailSetting information.
String	getDescription() Returns the description of this EmailSetting.
String	getId() Returns the id of this EmailSetting.
StorageProvider	getStorageProvider() Returns the storage provider if any.
boolean	setActive(boolean active) Sets EmailSetting active or not active.
boolean	setDefault() Sets EmailSetting as default for the enterprise.
boolean	setDescription(String description) Sets the description of this EmailSetting. Returns false if already used.
boolean	setDomain(String domainId, String subDomain) Sets the domain for this EmailSetting. Pass null to remove the domain. Changes can be made until one or more Pal Email Accounts are associated with these settings.
boolean	setInboundSettings(Data data) Sets Inbound EmailSetting information.
	setPal(String palId) Sets or removes the Pal related to this setting. See Pal.getMailBox().
boolean	setSmtpSettings(Data data) Sets SMTP EmailSetting information.
	setStorageProvider(StorageProvider storageProvider) Sets or removes the storage provider.
int	testInboundSettings() Tests the inbound configuration and returns the results. A result of -1 indicates an error.
int	testInboundSettings(Data data) Tests the inbound configuration and returns the results. A result of -1 indicates an error.
boolean	testSmtpSettings(String email) Tests the smtp configuration and returns the results.
boolean	testSmtpSettings(String email, Data data) Tests the smtp configuration and returns the results.
String	toString() Returns a description of this object.

Method Detail

Data getData()

Returns EmailSetting information.

Returns: Data

Since: 02-10-2011

top

String getDescription()

Returns the description of this EmailSetting.

Returns: String

Since: 02-10-2011

top

String getId()

Returns the id of this EmailSetting.

Returns: String

Since: 02-10-2011

top

StorageProvider getStorageProvider()

Returns the storage provider if any.

Returns: StorageProvider

Since: 06-19-2020

top

boolean setActive(boolean active)

Sets EmailSetting active or not active.

Parameters:

boolean active Required parameter.

Returns: boolean

Since: 02-10-2011

top

boolean setDefault()

Sets EmailSetting as default for the enterprise.

Returns: boolean

Since: 02-10-2011

top

boolean setDescription(String description)

Sets the description of this EmailSetting. Returns false if already used.

Parameters:

String description Required parameter. Maximum allowed size of parameter: 64

Returns: boolean

Since: 02-10-2011

top

boolean setDomain(String domainId, String subDomain)

Sets the domain for this EmailSetting. Pass null to remove the domain. Changes can be made until one or more Pal Email Accounts are associated with these settings.

Parameters:

String domainId
String subDomain

Returns: boolean

Since: 02-10-2011

top

boolean setInboundSettings(Data data)

Sets Inbound EmailSetting information.

Parameters:

Data data

Returns: boolean

Since: 02-10-2011

top

setPal(String palId)

Sets or removes the Pal related to this setting. See Pal.getMailBox().

Parameters:

String palId

Since: 12-10-2013

top

boolean setSmtpSettings(Data data)

Sets SMTP EmailSetting information.

Parameters:

Data data

Returns: boolean

Since: 02-10-2011

top

setStorageProvider(StorageProvider storageProvider)

Sets or removes the storage provider.

Parameters:

StorageProvider storageProvider

Since: 06-19-2020

top

int testInboundSettings()

Tests the inbound configuration and returns the results. A result of -1 indicates an error.

Returns: int

Since: 02-10-2011

top

int testInboundSettings(Data data)

Tests the inbound configuration and returns the results. A result of -1 indicates an error.

Parameters:

Data data - data to test. Required parameter.

Returns: int

Since: 01-17-2012

top

boolean testSmtpSettings(String email)

Tests the smtp configuration and returns the results.

Parameters:

String email Required parameter.

Returns: boolean

Since: 02-10-2011

top

boolean testSmtpSettings(String email, Data data)

Tests the smtp configuration and returns the results.

Parameters:

String email Required parameter.
Data data - data to test. Required parameter.

Returns: boolean

Since: 01-17-2012

top

String toString()

Returns a description of this object.

Returns: String

Since: 02-10-2011

top

API Date: Nov 18, 2024 01:04 PM