InternalEmailManager

Method Summary
	block(String emailAddress, String reason) Blocks sending to the email address.
InternalEmailSettings	createEmailSettings(String description) Creates a new EmailSetting.
	deleteBlock(String emailAddress) Deletes the specified email address from the block list.
boolean	deleteEmailSettings(String settingId) Deletes specified EmailSetting.
SystemDataView	getEmailBlockList() Returns the email block list for the enterprise.
SystemDataView	getEmailSettings() Returns the EmailSettings for the enterprise.
InternalEmailSettings	getEmailSettings(String settingId) Returns specified EmailSetting.
SystemDataView	getSystemEmailBlockList() Returns the email block list for the system.
SystemDataView	getSystemEmailJobs(String enterpriseId) Returns the email jobs.
boolean	isDescriptionUnique(String description) Returns true if the description is unique for the enterprise.
String	toString() Returns a description of this object.
	unBlock(String emailAddress) Resets the specified email address on the block list allowing future sending of email to the address.

Method Detail

block(String emailAddress, String reason)

Blocks sending to the email address.

Parameters:

String emailAddress Required parameter.
String reason Required parameter.

Since: 02-14-2018

top

InternalEmailSettings createEmailSettings(String description)

Creates a new EmailSetting.

Parameters:

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

Returns: InternalEmailSettings

Since: 02-10-2011

top

deleteBlock(String emailAddress)

Deletes the specified email address from the block list.

Parameters:

String emailAddress Required parameter.

Since: 01-07-2016

top

boolean deleteEmailSettings(String settingId)

Deletes specified EmailSetting.

Parameters:

String settingId Required parameter.

Returns: boolean

Since: 02-10-2011

top

SystemDataView getEmailBlockList()

Returns the email block list for the enterprise.

Returns: SystemDataView

DataList Name: EmailBlocks

DataList Keys/Column Name	Column Type	Read Only
email	String
palId	String
palName	String
reason	String
statusCode	Number
blocked	Boolean
blocks	Number
resets	Number
lastBlock	Date

Since: 01-07-2016

top

SystemDataView getEmailSettings()

Returns the EmailSettings for the enterprise.

Returns: SystemDataView

DataList Name: EmailSettings

DataList Keys/Column Name	Column Type	Read Only
id	String
palId	String
palName	String
description	String
enterpriseDefault	Boolean
active	Boolean
smtp	Boolean
inbound	Boolean
palEmailDomain	String

Since: 02-10-2011

top

InternalEmailSettings getEmailSettings(String settingId)

Returns specified EmailSetting.

Parameters:

String settingId Required parameter.

Returns: InternalEmailSettings

Since: 02-10-2011

top

SystemDataView getSystemEmailBlockList()

Returns the email block list for the system.

Returns: SystemDataView

DataList Name: SystemEmailBlocks

DataList Keys/Column Name	Column Type	Read Only
email	String
palId	String
palName	String
reason	String
statusCode	Number
blocked	Boolean
blocks	Number
resets	Number
lastBlock	Date
enterpriseName	String
enterpriseId	String

Since: 01-07-2016

top

SystemDataView getSystemEmailJobs(String enterpriseId)

Returns the email jobs.

Parameters:

String enterpriseId Required parameter.

Returns: SystemDataView

DataList Name: SystemEmailJobs

DataList Keys/Column Name	Column Type	Read Only
id	String
email	String
subject	String
status	String
createDate	Date
sent	Date
expireDate	Date
attempts	Number
nextAttempt	Date
replyTo	String
type	String
sendDate	Date
deliveryStatus	String
palId	String
palName	String
enterpriseName	String
enterpriseId	String

Since: 01-07-2016

top

boolean isDescriptionUnique(String description)

Returns true if the description is unique for the enterprise.

Parameters:

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

Returns: boolean

Since: 02-10-2011

top

String toString()

Returns a description of this object.

Returns: String

Since: 02-10-2011

top

unBlock(String emailAddress)

Resets the specified email address on the block list allowing future sending of email to the address.

Parameters:

String emailAddress Required parameter.

Since: 01-07-2016

top

API Date: Dec 03, 2024 10:24 AM