Email parameters in Parameter(SysEmailParameters)

Latest version of the JSON entity definition is available on GitHub.

Traits

Traits for this entity are listed below.

is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	SysEmailParameters/(resolvedAttributes)/RecId	attribute

is.CDM.entityVersion

Parameter	Value	Data type	Explanation
versionNumber	"1.0"	string	semantic version number of the entity

is.application.releaseVersion

Parameter	Value	Data type	Explanation
releaseVersion	"10.0.13.0"	string	semantic version number of the application introducing this entity

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Email parameters	entity	a reference to the constant entity holding the list of localized text

Attributes

Name	Description	First Included in Instance
RecId		Parameter/SysEmailParameters
AttachmentsPath		Parameter/SysEmailParameters
Key		Parameter/SysEmailParameters
MaxEmailAttachmentSize		Parameter/SysEmailParameters
SMTPUseNTLM		Parameter/SysEmailParameters
SMTPPortNumber		Parameter/SysEmailParameters
SMTPRelayServerName		Parameter/SysEmailParameters
SMTPUserName		Parameter/SysEmailParameters
SMTPRequireSSL		Parameter/SysEmailParameters
MailerNonInteractive		Parameter/SysEmailParameters
MailerInteractiveEnabled		Parameter/SysEmailParameters
NumDaysToRetainHistory		Parameter/SysEmailParameters
ExpirationInDays		Parameter/SysEmailParameters

RecId

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
isPrimaryKey	true
dataFormat	int64
isReadOnly	true

Traits

List of traits for the RecId attribute are listed below.

is.dataFormat.integer
is.dataFormat.big
is.identifiedBy
names a specifc identity attribute to use with an entity

Parameter	Value	Data type	Explanation
attribute	SysEmailParameters/(resolvedAttributes)/RecId	attribute

is.readOnly
is.dataFormat.integer
is.dataFormat.big

AttachmentsPath

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the AttachmentsPath attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

Key

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
dataFormat	int32
isReadOnly	true
isNullable	true

Traits

List of traits for the Key attribute are listed below.

is.dataFormat.integer
is.readOnly
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

MaxEmailAttachmentSize

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the MaxEmailAttachmentSize attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

SMTPUseNTLM

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
displayName	Use default credentials
dataFormat	int32
isNullable	true

Traits

List of traits for the SMTPUseNTLM attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Use default credentials	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.integer

SMTPPortNumber

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the SMTPPortNumber attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

SMTPRelayServerName

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the SMTPRelayServerName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

SMTPUserName

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
dataFormat	string
isNullable	true

Traits

List of traits for the SMTPUserName attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.nullable
The attribute value may be set to NULL.

is.dataFormat.character
is.dataFormat.array

SMTPRequireSSL

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the SMTPRequireSSL attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

MailerNonInteractive

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
displayName	Batch email provider
dataFormat	string

Traits

List of traits for the MailerNonInteractive attribute are listed below.

is.dataFormat.character
is.dataFormat.big
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Batch email provider	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.character
is.dataFormat.array

MailerInteractiveEnabled

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
displayName	Enabled interactive email providers
dataFormat	binary

Traits

List of traits for the MailerInteractiveEnabled attribute are listed below.

is.dataFormat.byte
is.dataFormat.array
is.localized.displayedAs
Holds the list of language specific display text for an object.

Parameter	Value	Data type	Explanation
localizedDisplayText	languageTag displayText en Enabled interactive email providers	entity	a reference to the constant entity holding the list of localized text

is.dataFormat.byte
is.dataFormat.array

NumDaysToRetainHistory

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the NumDaysToRetainHistory attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer

ExpirationInDays

First included in: Parameter/SysEmailParameters (this entity)

Properties

Name	Value
dataFormat	int32
isNullable	true

Traits

List of traits for the ExpirationInDays attribute are listed below.

is.dataFormat.integer
is.nullable
The attribute value may be set to NULL.

is.dataFormat.integer