Domains
Represents Mailgun domains. Each row is a domain configured in your Mailgun account.
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | Xs:string | True |
Unique identifier for the domain. | |
| Name [KEY] | Xs:string | False |
The domain name. | |
| ArchiveTo | Xs:string | True |
URL that a copy of each successfully delivered message is going to be posted to. | |
| CreatedAt | Xs:dateTime | True |
Date and time when the domain was created. | |
| IsDisabled | Xs:boolean | True |
Indicates if the domain is disabled. | |
| RequireTLS | Xs:boolean | False |
Indicates if TLS is required for the domain. | |
| SkipVerification | Xs:boolean | False |
Indicates if verification is skipped for the domain. | |
| SmtpLogin | Xs:string | True |
SMTP login for the domain. | |
| SmtpPassword | Xs:string | False |
SMTP password for the domain. | |
| SpamAction | Xs:string | False |
Action taken when spam is detected. The allowed values are disabled, block, tag. | |
| SubaccountId | Xs:string | True |
The subaccount ID the domain belongs to. This field is only present if the domain is associated with a subaccount. | |
| State | Xs:string | True |
Current state of the domain (e.g., active, disabled). | |
| Type | Xs:string | True |
Classification of the domain. Possible values are custom or sandbox. | |
| TrackingHost | Xs:string | True |
Custom tracking host for the domain used for tracking opens and clicks if configured. | |
| UseAutomaticSenderSecurity | Xs:boolean | False |
If true Mailgun manages DKIM key generation and DNS record configuration automatically. | |
| WebPrefix | Xs:string | False |
Web prefix for the domain. | |
| WebScheme | Xs:string | False |
Web scheme used for the domain. The allowed values are https, http. | |
| DisabledPermanantly | Xs:boolean | True |
Indicates whether the domain is permanently disabled. | |
| Wildcard | Xs:boolean | False |
Indicates if the domain is a wildcard domain and can receive emails for any subdomain. | |
| DisabledCode | Xs:string | True |
Code indicating the reason for the domain being disabled. | |
| DisabledNote | Xs:string | True |
Additional information about why the domain was disabled. | |
| DisabledReason | Xs:string | True |
Additional information about why the domain was disabled. | |
| DisabledUntil | Xs:string | True |
Timestamp in RFC1123 format indicating when the domain will be re-enabled if the disablement is temporary. | |
| EncryptIncomingMessage | Xs:boolean | False |
If true incoming messages to this domain will be encrypted. | |
| MessageTTL | Xs:integer | False |
Time-to-live (TTL) in seconds for retrieving both incoming and outgoing messages. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| Authority | Xs:string |
Get only domains with a specific authority. If state is specified then only state filtering will be proceed. |
| IncludeSubaccounts | Xs:boolean |
Search on every domain that belongs to any subaccounts under this account. |
| Search | Xs:string |
Search domains by the given partial or complete name. |