Mail-in-a-Box · JSON-LD Context

Mail In A Box Context

JSON-LD context defining the semantic vocabulary for Mail In A Box from Mail-in-a-Box.

43 Classes 60 Properties 4 Namespaces
View Context View on GitHub

Namespaces

schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
mail: https://mailinabox.email/schema#

Classes

MailUsersResponseFormat MailAliasesResponseFormat MailUserByDomain MailUser MailAliasByDomain MailAlias MailAliasUpsertRequest MailAliasRemoveRequest DNSRecordType DNSDumpDomainRecord DNSCustomRecord DNSSecondaryNameserverResponse DNSUpdateRequest DNSSecondaryNameserverAddRequest SystemPrivacyUpdateRequest SystemPrivacyStatus MailUserSetPasswordRequest MailUserAddRequest MailUserRemoveRequest MailUserStatus MailUserPrivilege MailUserAddPrivilegeRequest MailUserRemovePrivilegeRequest SSLCSRGenerateRequest SSLCertificateInstallRequest SSLCertificatesProvisionResponse StatusEntry StatusEntryType StatusEntryExtra SystemBackupConfigUpdateRequest SystemBackupConfigResponse SystemBackupStatusResponse SystemBackupStatus SSLStatusResponse SSLStatus SSLStatusType MeResponse MeAuthStatus WebDomain MfaStatusResponse MfaEnableRequest MfaDisableRequest LogoutResponse

Properties

Property Type Container
domain reference
users list
email reference
privileges list
status reference
mailbox string
aliases list
address reference
address_display reference
forwards_to list
permitted_senders list
required boolean
update_if_exists integer
explanation string
qname reference
rtype reference
value string
hostnames list
force integer
password string
privilege reference
countrycode string
cert string
chain string
requests list
type reference
text string
extra list
monospace boolean
target string
target_user string
target_pass string
min_age integer
enc_pw_file string
file_target_directory string
min_age_in_days integer
ssh_pub_key string
backups list
unmatched_file_size integer
error string
date dateTime
date_delta string
date_str string
deleted_in string
full boolean
size integer
volumes integer
can_provision list
api_key string
reason string
custom_root string
root string
ssl_certificate list
static_enabled boolean
enabled_mfa
new_mfa
secret string
code string
label string
mfa_id string

JSON-LD Document

Raw ↑
{
  "@context": {
    "@vocab": "https://mailinabox.email/schema#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "mail": "https://mailinabox.email/schema#",
    "MailUsersResponseFormat": "mail:MailUsersResponseFormat",
    "MailAliasesResponseFormat": "mail:MailAliasesResponseFormat",
    "MailUserByDomain": "mail:MailUserByDomain",
    "domain": {
      "@id": "mail:domain",
      "@type": "@id"
    },
    "users": {
      "@id": "mail:users",
      "@container": "@list"
    },
    "MailUser": "mail:MailUser",
    "email": {
      "@id": "mail:email",
      "@type": "@id"
    },
    "privileges": {
      "@id": "mail:privileges",
      "@container": "@list"
    },
    "status": {
      "@id": "mail:status",
      "@type": "@id"
    },
    "mailbox": {
      "@id": "mail:mailbox",
      "@type": "xsd:string"
    },
    "MailAliasByDomain": "mail:MailAliasByDomain",
    "aliases": {
      "@id": "mail:aliases",
      "@container": "@list"
    },
    "MailAlias": "mail:MailAlias",
    "address": {
      "@id": "mail:address",
      "@type": "@id"
    },
    "address_display": {
      "@id": "mail:address_display",
      "@type": "@id"
    },
    "forwards_to": {
      "@id": "mail:forwards_to",
      "@container": "@list"
    },
    "permitted_senders": {
      "@id": "mail:permitted_senders",
      "@container": "@list"
    },
    "required": {
      "@id": "mail:required",
      "@type": "xsd:boolean"
    },
    "MailAliasUpsertRequest": "mail:MailAliasUpsertRequest",
    "update_if_exists": {
      "@id": "mail:update_if_exists",
      "@type": "xsd:integer"
    },
    "MailAliasRemoveRequest": "mail:MailAliasRemoveRequest",
    "DNSRecordType": "mail:DNSRecordType",
    "DNSDumpDomainRecord": "mail:DNSDumpDomainRecord",
    "explanation": {
      "@id": "mail:explanation",
      "@type": "xsd:string"
    },
    "qname": {
      "@id": "mail:qname",
      "@type": "@id"
    },
    "rtype": {
      "@id": "mail:rtype",
      "@type": "@id"
    },
    "value": {
      "@id": "mail:value",
      "@type": "xsd:string"
    },
    "DNSCustomRecord": "mail:DNSCustomRecord",
    "DNSSecondaryNameserverResponse": "mail:DNSSecondaryNameserverResponse",
    "hostnames": {
      "@id": "mail:hostnames",
      "@container": "@list"
    },
    "DNSUpdateRequest": "mail:DNSUpdateRequest",
    "force": {
      "@id": "mail:force",
      "@type": "xsd:integer"
    },
    "DNSSecondaryNameserverAddRequest": "mail:DNSSecondaryNameserverAddRequest",
    "SystemPrivacyUpdateRequest": "mail:SystemPrivacyUpdateRequest",
    "SystemPrivacyStatus": "mail:SystemPrivacyStatus",
    "MailUserSetPasswordRequest": "mail:MailUserSetPasswordRequest",
    "password": {
      "@id": "mail:password",
      "@type": "xsd:string"
    },
    "MailUserAddRequest": "mail:MailUserAddRequest",
    "MailUserRemoveRequest": "mail:MailUserRemoveRequest",
    "MailUserStatus": "mail:MailUserStatus",
    "MailUserPrivilege": "mail:MailUserPrivilege",
    "MailUserAddPrivilegeRequest": "mail:MailUserAddPrivilegeRequest",
    "privilege": {
      "@id": "mail:privilege",
      "@type": "@id"
    },
    "MailUserRemovePrivilegeRequest": "mail:MailUserRemovePrivilegeRequest",
    "SSLCSRGenerateRequest": "mail:SSLCSRGenerateRequest",
    "countrycode": {
      "@id": "mail:countrycode",
      "@type": "xsd:string"
    },
    "SSLCertificateInstallRequest": "mail:SSLCertificateInstallRequest",
    "cert": {
      "@id": "mail:cert",
      "@type": "xsd:string"
    },
    "chain": {
      "@id": "mail:chain",
      "@type": "xsd:string"
    },
    "SSLCertificatesProvisionResponse": "mail:SSLCertificatesProvisionResponse",
    "requests": {
      "@id": "mail:requests",
      "@container": "@list"
    },
    "StatusEntry": "mail:StatusEntry",
    "type": {
      "@id": "mail:type",
      "@type": "@id"
    },
    "text": {
      "@id": "mail:text",
      "@type": "xsd:string"
    },
    "extra": {
      "@id": "mail:extra",
      "@container": "@list"
    },
    "StatusEntryType": "mail:StatusEntryType",
    "StatusEntryExtra": "mail:StatusEntryExtra",
    "monospace": {
      "@id": "mail:monospace",
      "@type": "xsd:boolean"
    },
    "SystemBackupConfigUpdateRequest": "mail:SystemBackupConfigUpdateRequest",
    "target": {
      "@id": "mail:target",
      "@type": "xsd:string"
    },
    "target_user": {
      "@id": "mail:target_user",
      "@type": "xsd:string"
    },
    "target_pass": {
      "@id": "mail:target_pass",
      "@type": "xsd:string"
    },
    "min_age": {
      "@id": "mail:min_age",
      "@type": "xsd:integer"
    },
    "SystemBackupConfigResponse": "mail:SystemBackupConfigResponse",
    "enc_pw_file": {
      "@id": "mail:enc_pw_file",
      "@type": "xsd:string"
    },
    "file_target_directory": {
      "@id": "mail:file_target_directory",
      "@type": "xsd:string"
    },
    "min_age_in_days": {
      "@id": "mail:min_age_in_days",
      "@type": "xsd:integer"
    },
    "ssh_pub_key": {
      "@id": "mail:ssh_pub_key",
      "@type": "xsd:string"
    },
    "SystemBackupStatusResponse": "mail:SystemBackupStatusResponse",
    "backups": {
      "@id": "mail:backups",
      "@container": "@list"
    },
    "unmatched_file_size": {
      "@id": "mail:unmatched_file_size",
      "@type": "xsd:integer"
    },
    "error": {
      "@id": "mail:error",
      "@type": "xsd:string"
    },
    "SystemBackupStatus": "mail:SystemBackupStatus",
    "date": {
      "@id": "mail:date",
      "@type": "xsd:dateTime"
    },
    "date_delta": {
      "@id": "mail:date_delta",
      "@type": "xsd:string"
    },
    "date_str": {
      "@id": "mail:date_str",
      "@type": "xsd:string"
    },
    "deleted_in": {
      "@id": "mail:deleted_in",
      "@type": "xsd:string"
    },
    "full": {
      "@id": "mail:full",
      "@type": "xsd:boolean"
    },
    "size": {
      "@id": "mail:size",
      "@type": "xsd:integer"
    },
    "volumes": {
      "@id": "mail:volumes",
      "@type": "xsd:integer"
    },
    "SSLStatusResponse": "mail:SSLStatusResponse",
    "can_provision": {
      "@id": "mail:can_provision",
      "@container": "@list"
    },
    "SSLStatus": "mail:SSLStatus",
    "SSLStatusType": "mail:SSLStatusType",
    "MeResponse": "mail:MeResponse",
    "api_key": {
      "@id": "mail:api_key",
      "@type": "xsd:string"
    },
    "reason": {
      "@id": "mail:reason",
      "@type": "xsd:string"
    },
    "MeAuthStatus": "mail:MeAuthStatus",
    "WebDomain": "mail:WebDomain",
    "custom_root": {
      "@id": "mail:custom_root",
      "@type": "xsd:string"
    },
    "root": {
      "@id": "mail:root",
      "@type": "xsd:string"
    },
    "ssl_certificate": {
      "@id": "mail:ssl_certificate",
      "@container": "@list"
    },
    "static_enabled": {
      "@id": "mail:static_enabled",
      "@type": "xsd:boolean"
    },
    "MfaStatusResponse": "mail:MfaStatusResponse",
    "enabled_mfa": {
      "@id": "mail:enabled_mfa"
    },
    "new_mfa": {
      "@id": "mail:new_mfa"
    },
    "MfaEnableRequest": "mail:MfaEnableRequest",
    "secret": {
      "@id": "mail:secret",
      "@type": "xsd:string"
    },
    "code": {
      "@id": "mail:code",
      "@type": "xsd:string"
    },
    "label": {
      "@id": "mail:label",
      "@type": "xsd:string"
    },
    "MfaDisableRequest": "mail:MfaDisableRequest",
    "mfa_id": {
      "@id": "mail:mfa_id",
      "@type": "xsd:string"
    },
    "LogoutResponse": "mail:LogoutResponse"
  },
  "@type": "schema:Dataset",
  "schema:name": "Mail-in-a-Box API JSON-LD context",
  "schema:description": "A JSON-LD @context for the objects Mail-in-a-Box's own API contract declares: one class per component schema, one property per declared field, typed from the contract. Derived by script (derive-json-ld.py, 2026-10-28) from openapi/mailinabox-openapi.yml.",
  "dcterms:created": "2026-10-28",
  "dcterms:source": [
    "openapi/mailinabox-openapi.yml"
  ]
}