action combell_get_mail_zone {
label: "Get the mail zone."
provider: combell
method: GET
path: "/mailzones/{domainName}"
encoding: json
input: {
type: "object"
properties: {
domainName: {
type: "string"
}
domain_name: {
type: "string"
description: "Mail zone domain name."
}
}
required: ["domainName", "domain_name"]
additionalProperties: false
}
output: {
type: "object"
properties: {
aliases: {
type: "array"
description: "List of aliases on the mail zone
\nAn alias is an e-mail address (alias) that automatically forwards received e-mails to another e-mail address (destination)."
items: {
type: "object"
properties: {
destinations: {
type: "array"
description: "The alias destination e-mail addresses"
items: {
type: "string"
}
}
email_address: {
type: "string"
description: "The alias e-mail address"
}
}
additionalProperties: false
}
}
anti_spam: {
type: "object"
properties: {
allowed_types: {
type: "array"
description: "Allowed types of anti-spam scanning for this mail zone"
items: {
type: "string"
description: "Types of anti-spam scanning"
enum: ["none", "advanced", "basic"]
}
}
type: {
type: "object"
additionalProperties: true
}
}
additionalProperties: false
}
available_accounts: {
type: "array"
description: "List of mail zone accounts with their mailbox size."
items: {
type: "object"
properties: {
account_id: {
type: "integer"
format: "int32"
description: "Mail zone account id, use this value to create a mailbox"
}
size: {
type: "integer"
format: "int32"
description: "Size of mailbox(es) in MB"
}
}
additionalProperties: false
}
}
catch_all: {
type: "object"
properties: {
email_addresses: {
type: "array"
description: "E-mail addresses to which all e-mails are sent to inexistent mailboxes or aliases"
items: {
type: "string"
}
}
}
additionalProperties: false
}
enabled: {
type: "boolean"
description: "Indicates whether the mail zone is enabled."
}
name: {
type: "string"
}
smtp_domains: {
type: "array"
description: "List of extra smtp domains on the mail zone
\nSMTP domain names allow you to link multiple domain names to a single e-mail address.
\nE-mails sent to an SMTP domain will be caught by the respective e-mail address on the main domain name."
items: {
type: "object"
properties: {
enabled: {
type: "boolean"
description: "Enabled"
}
hostname: {
type: "string"
description: "The smtp domain name"
}
}
additionalProperties: false
}
}
}
additionalProperties: false
}
}