api.mailbox.org

Account name, Username for customer login

Password for customer login

Account tariff

allowed values:

Tarif Limit as array, tariff is key, limit is value

Memo

Account to be deleted

Account

Account-Name

Customer type

possible values:

Account Status

possible values:

Account tariff

possible values:

Company name

VAT ID

Memo

Monthly account charge

Invoice delivery method

possible values:

Payment method

possible values:

Maximum of available mailinglists

Limits how many mails can be created per tariff

Account which belongs to the invoice.

Download-Token

Account

Invoice ID

Invoice date

Invoice status

Download token

Account, der verändert werden soll

Neues Passwort

Tarif des Accounts

allowed values:

Memo

Rechnungsvorname

Rechnungsnachname

Rechnungsstrasse

Rechnungspostleitzahl

Rechnungsort

Company Name

bei Lastschrifteinzug: IBAN

bei Lastschrifteinzug: BIC

bei Lastschrifteinzug: Kontoinhaber

Name der Person, die den AV-Vertrag für diesen Account in der aktuellen Version akzeptiert. Der AV-Vertrag wird damit als unterschrieben markiert.

Tarif Limit as array, tariff is key, limit is value

For people with professions bound to professional discretion

Parent email account of which the additional email account shall be deleted

Additional email account to be deleted

Username

Password

Session-ID / Auth-ID

User level of the account

Account for which contexts are to be listed

Account to which this operation is to be applied

Domain name to be added

Domain password

Context-ID to be associated to the new domain. required unless create_new_context_id is used.

If true then a new Context-ID will be generated and associated to the domain. required unless context_id is used.

Memo

Hostname to contain the TXT record

Value for the TXT record

Domain to be modified

Capabilities to set

allowed values:

Account that owns the domain

Domain to be deleted

Domain to which this operation is to be applied

Domain name

Domain status

Context-ID

Registration date

Memo

Available plans for mails

Account to which this operation is to be applied

Search filter

Domain name

Number of email addresses defined for this domain

Domain to be modified

New password

Context-ID to be associated to this domain. CAUTION: If the Context-ID changes for an email address that belongs to a domain, any associated Cloud office data (drive, calendar, address book) will be lost; However, the email messages will be preserved.

Parameter available for user level (and above): account

If true then a new Context-ID will be generated and associated with the domain.

Parameter available for user level (and above): account

Memo

Domain to which this operation is to be applied

Domain name

Mailbox.org SPF status

Mailbox.org SPF string

Domain SPF entry

Name of the Group to be added

Name of the group to be displayed.

array containing mail address strings to be added to the group.

Name of the Group to be deleted

internal group id

group name identifier

customer display name

array of member email addresses

Name of the Group to be edited

Name of the group to be displayed.

array containing mail address strings to be added to the group.

array containing mail address strings to be removed from the group.

Email address to be added

Password for the new email address. Not required if the parameter password_hash is present.

LDAP-compatible password hash. Example: {SSHA}hdF+6b0xKmkWNZfHrVfUlWqo10M7nje6 If password_hash is used, it's not allowed to use the password parameter.

If true then password reset is required with first/next login

Tariff associated to the email address

allowed values:

If you signed up before 13.4.2021, you can still use the following old rates:

Additional quota for mail storage in gb

Additional quota for cloud storage in gb

First name

Last name

Enable saving messages in inbox

Forwarding list. Leave array empty if no forwarding desired

Memo

Comma separated list of allowed networks to access this mailbox

If true then a catch-all email address must be specified. Further, there must be at least one forwarding rule, and inboxsave set to false. The address must begin with @

If true then a dedicated context will be created for this email address

Title

Birthday (YYYY-MM-DD)

Position

Department

Company

Street address (business)

ZIP or Postcode (business)

Town or City (business)

Phone number (business)

Fax number (business)

Mobile / Cell number (business)

If true, only the parameter mail is required and other parameters will be ignored. Recovers a given email address from the deletelist if it has been deleted recently. Emails will be recovered, other data like openxchange calendar or saved files in openxchange drive will not.

If true, no welcome mail will be sent when the mail address is created.

Optional External UID. Must be unique within account

locale in accordance to RFC5646, Example: en_GB

Email address for which a new app password is generated

Space for memo regarding the new password

id of the password to be deleted

Email address for which the app passwords should be listed

id of password

memo for password

Email address for the import

ID of the backup to be imported as received from mail.backup.list. Example: backup_4

Time string of the backup to be imported as received from mail.backup.list. Example: 2022-03-17 11:07

all or an IMAP foldername

Email address to list backups for

Email address where we want to add a blacklist entry

Email address to be added to the blacklist

Email address where we want to delete a blacklist entry

Email address to be deleted from the blacklist

Email address which contains the blacklist

Email to be modified

Capabilities to set

allowed values:

Email address to be deleted

Account to which this operation is to be applied

The external UID of the mail

Mail address

Typ

possible values:

Tarif

possible values:

Available plans

possible values:

First name

Last name

Save to inbox boolean

Passowrd reset required with next login boolean

Array of forwarding addresses

Array of alias addresses

alternative email address

Memo

Comma separated list of allowed networks to access this mailbox

External UID

Email address enabled or disabled boolean

Title

Birthday (YYYY-MM-DD)

Position

Department

Company

Street address (business)

ZIP or Postcode (business)

Town or City (business)

Phone number (business)

Fax number (business)

Mobile / Cell number (business)

language in RFC5646 format

product capabilities

possible values:

Email address to be used

whether to also return used mail and cloud quota

Mail address

Typ

possible values:

Tarif

possible values:

Available plans

possible values:

First name

Last name

Save to inbox boolean

Passowrd reset required with next login boolean

Array of forwarding addresses

Array of alias addresses

alternative email address

Memo

Comma separated list of allowed networks to access this mailbox

External UID

Email address enabled or disabled boolean

Title

Birthday (YYYY-MM-DD)

Position

Department

Company

Street address (business)

ZIP or Postcode (business)

Town or City (business)

Phone number (business)

Fax number (business)

Mobile / Cell number (business)

language in RFC5646 format

product capabilities

possible values:

Domain to which this operation is to be applied

Whether to return more detailed information about mail accounts

Mailadresse

Type: forward, inbox, inboxforward

Email address to be used

Email address to be used

Phone number for password reset SMS (will be verified against the stored number), please use country code like +49

Email address to be used

Password reset token

The new password to be set

Token that defines the domain and tariff to be associated to the email address

Email address to be created

Password for the new email address

Alternative email address

First name

Last name

Welcome email language (default: en)

allowed values:

Email address to be modified

New password

LDAP-compatible password hash. Example: {SSHA}hdF+6b0xKmkWNZfHrVfUlWqo10M7nje6 If password_hash is used, it's not allowed to use the password parameter.

forces the password parameter to be a new password, different from the currently stored password

If true then password reset is required with first/next login

Email plan

allowed values:

Additional quota for mail storage in gb

Additional quota for cloud storage in gb

First name

Last name

Enable saving messages in inbox

Forwarding list. Leave array empty if no forwarding desired

List of alias addresses. To delete the list, set an empty array. For no changes to aliases, skip this parameter and do not set a value. The alias address must belong to a domain that is associated to the master account

alternative email address

Memo

Comma separated list of allowed networks to access this mailbox. Empty string for deleting the current saved configuration.

If set to false then the email address will be disabled

Title

Birthday (YYYY-MM-DD)

Position

Department

Company

Street address (business)

ZIP or Postcode (business)

Town or City (business)

Phone number (business)

Fax number (business)

Mobile / Cell number (business)

Optional External UID. Must be unique within account

locale in accordance to RFC5646, Example: en_GB

A capability set for this account which isn't allowed in the new tariff (e.g. backuprecover)

The account uses more internal aliasses than allowed in the new tariff

The account uses more own domain aliasses than allowed in the new tariff

The account uses more disposable aliasses than allowed in the new tariff

There are more pop3fetch jobs configured than allowed in the new tariff

The account uses more cloud quota than allowed in the new tariff

The account uses more mail quota than allowed in the new tariff

This change can only be done by the team master

It's not allowed to have old and new tariffs in the same team

The account uses more video rooms than allowed in the new tariff

Email address for reading spamprotection settings

Greylisting

possible values:

SMTP plausibility check

possible values:

Real-time Blacklist (RBL)

possible values:

Executable files as attachments

possible values:

float value for the content spam filter (e.g. 5.5)

reject or redirect spam emails

possible values:

IMAP foldername, to which spam emails will be redirected if killevel = route

an array of the user's IMAP foldernames

Email address for setting spamprotection settings

Greylisting

allowed values:

SMTP plausibility check

allowed values:

Real-time Blacklist (RBL)

allowed values:

Executable files as attachments

allowed values:

float value for the content spam filter (e.g. 5.5)

reject or redirect spam emails

allowed values:

IMAP foldername, to which spam emails will be redirected if killevel = route

Email address to delete the active automatic mail response for

true on success

integer code on error

error message on error

Email address to get the active automatic mail response for

message containing info that an automatic mail response is not active

subject of the active automatic mail response

body of the active automatic mail response

array with mail addresses for which the automatic mail response is also active

start date of the automatic mail response in the format YYYY-MM-DD

end date of the automatic mail response in the format YYYY-MM-DD

Email address to set the automatic mail response for

subject of the automatic mail response

message body of the automatic mail response

start date of the automatic mail response in format YYYY-MM-DD (2022-12-23)

end date of the automatic mail response in format YYYY-MM-DD (2023-01-07)

array containing mail address strings for which the automatic mail response should also be active

true on success

integer code on error

error message on error

Mailing list name

Mailing list status

Mailing list admin mail

Search query

if the result should contain more infos about found accounts

An array of account names or an array of account objects if parameter 'get_account_summary' was true

An array of domains

An array of emails

Account

Domain

Value to be validated

allow mail extensions with '+'

Description of the validator

allowed values: