Help Center
Login Sign up
  1. Home
  2. API reference
  3. API documentation (JSON/XML)
  4. Objects

MailProxy object

API reference (XML/JSON) · Updated 2023-09-25

Description

The MailProxy object represents a MailProxy.

Structure

Keyword JSONKeywordXMLOccursTypeFormatDescription
admin

admin

0 - 1

string

email

Email address of the administrator to whom notifications are sent.

bannedFilesbanned_files0 - 1objectMailProxyPolicyDefines whether files should be checked and how banned files should be avoided.
blacklistblacklist0 - 1objectMailListSpecification of email addresses whose mails are always to be marked as spam.
createdcreated0 - 1stringdate-timeDate on which the MailProxy was created.
domaindomain1stringdomain

Domains for which the MailProxy is used.

excludelistexclude0 - 1objectMailListDefinition of administrative addresses that should never be ignored by spam filters. An example of this is the "Hostmaster" addresses, e.g. hostmaster@example.com.
greylistinggreylisting0 - 1objectGreylistingPolicyIf greylisting is activated, the first email from an unknown sender is rejected at first. Mails from this sender will only be accepted after a further delayed delivery attempt.
headerheader0 - 1object

MailProxyPolicy

Defines whether headers are to be checked and how banned headers are to be handled.
idnidn0 - 1string
IDN version of the domain name
ownerowner
objectBasicUserObject owner
protection

protection

0 - 1

enum

Mailproxy_Protection

Security settings for handling infected mails.
spamspam0 - 1objectSpamPolicyPolicy für spam
targettarget1stringhostname
Mail server to which the MailProxy should forward the emails.
Note that the MX record of your mail server must be removed from the zone.
updatedupdated0 - 1stringdate-timeDate on which the MailProxy was last updated.
updaterupdater0 - 1objectBasicUserUser who performed the last update.
virusvirus0 - 1objectMailProxyPolicyDefines whether to check for viruses and how to deal with detected viruses.
whitelistwhitelist0 - 1objectMailListDefine email addresses whose mails should be trusted and never marked as spam.