SoftLayer Dns Domain ResourceRecord MxType
From SoftLayer Development Network Wiki
Contents |
Overview
SoftLayer_Dns_Domain_ResourceRecord_MxType is a SoftLayer_Dns_Domain_ResourceRecord object whose type property is set to "mx" and used to describe MX resource records. MX records control which hosts are responsible as mail exchangers for a domain. For instance, in the domain example.org, an MX record whose host is "@" and data is "mail" says that the host "mail.example.org" is responsible for handling mail for example.org. That means mail sent to users @example.org are delivered to mail.example.org.
Domains can have more than one MX record if it uses more than one server to send mail through. Multiple MX records are denoted by their priority, defined by the mxPriority property.
MX records must be defined for hosts with accompanying A resource records. They may not point mail towards a host defined by a CNAME record.
User Access
Users wishing to access the SoftLayer_Dns_Domain_ResourceRecord_MxType type must have the Manage DNS permission assigned to their account.
| Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties. |
Local Properties
data
The value of a domain's resource record. This can be an IP address or a hostname. Fully qualified host and domain name data must end with the "." character.
data is required for object creation.
- Type: string
- Length: 255 characters
domainId
An identifier belonging to the domain that a resource record is associated with.
domainId is required for object creation.
- Type: integer
- Length: 8 digits
host
The host defined by a resource record. A value of "@" denotes a wildcard.
host is required for object creation.
- Type: string
- Length: 50 characters
- Default Value: @
id
A domain resource record's internal identifier.
- Type: integer
mxPriority
Useful in cases where a domain has more than one mail exchanger, the priority property is the priority of the MTA that delivers mail for a domain. A lower number denotes a higher priority, and mail will attempt to deliver through that MTA before moving to lower priority mail servers. Priority is defaulted to 10 upon resource record creation.
mxPriority is required for object creation.
- Type: integer
- Length: 8 digits
- Default Value: 10
ttl
The Time To Live value of a resource record, measured in seconds. TTL is used by a name server to determine how long to cache a resource record. An SOA record's TTL value defines the domain's overall TTL.
ttl is required for object creation.
- Type: integer
- Length: 8 digits
- Default Value: 86400
type
The string "mx" which defines a resource record as an MX record.
type is required for object creation.
- Type: string
- Length: 5 characters
Relational Properties
domain
The domain that a resource record belongs to.
domain can be queried by object mask.
domain must be a unique value.
- Type: SoftLayer_Dns_Domain
