api.mailbox.org

account.add

Creates a new account

Available for user level: reseller

Parameter:

Req Name Type Description
★ account string

Account name, Username for customer login
★ password string

Password for customer login
★ plan string

Account tariff

allowed values:

Value Description
basic

Business Basic package
profi

Business Professional package
profixl

Business Professional XL package
reseller

Reseller special rate

tarifflimits array

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

Memo

Return Type:

array

Same as account.get

account.del

Deletes an existing account

Account will be deleted recursive, all domains and mailaddresses will be deleted as well.

Available for user level: adminreseller

Parameter:

Req Name Type Description
★ account string

Account to be deleted

Return Type:

boolean

account.get

Returns information about an account

Available for user level: adminreselleraccount

Parameter:

Req Name Type Description
★ account string

Account

Return Type:

array

Name Description
account

Account-Name
type

Customer type

possible values:

Value Description
BMBO

A mailbox.org business customer

status

Account Status

possible values:

Value Description
aktiv

enabled
nopop

nopop
disabled

disabled
deleted

deleted

plan

Account tariff

possible values:

Value Description
basic

Business Basic package
profi

Business Professional package
profixl

Business Professional XL package
reseller

Reseller special rate

old_customer

Name Description
desc

Account old/new pricing

company

Company name
ustid

VAT ID
address_main

Name Description
salutation

Salutation

possible values:

Value Description
herr

for male customers
frau

for female customers

first_name

The customer's first name
last_name

The customer's last name
birthday

The customer's date of birth (YYYY-MM-DD)
street

Street address
zipcode

ZIP or Postcode
town

Town or City
country

Country

address_payment

Name Description
same_as_main

Billing- and account address are the same
first_name

Billing address: First name
last_name

Billing address: Last name
street

Billing address: Street address
zipcode

Billing address: ZIP or Postcode
town

Billing address: Town or City

bank

Name Description
iban

Payment by Direct Debit only: IBAN
bic

Payment by Direct Debit only: BIC
account_owner

Payment by Direct Debit only: Account holder
name

Payment by Direct Debit only: Name of the bank

contact

Name Description
mail

Contact e-mail address of the account owner
mail_payment

Different e-mail address for billing
phone

Phone number
fax

Fax number
mobile

Mobile / Cell number

memo

Memo
monthly_fee

Monthly account charge
invoice_type

Invoice delivery method

possible values:

Value Description
mail

E-mail
post

Paper

payment_type

Payment method

possible values:

Value Description
invoice

Invoice
dta

Direct Debit

av_contract

Name Description
signed

true, if an AV-contract has been signed
info

if signed: Array consisting of the keys name, date and version.
professional_secrecy

bool, only available if AV-contract has been signed

max_mailinglist

Maximum of available mailinglists
tarifflimits

Limits how many mails can be created per tariff

account.invoice.get

PDF binary of an invoice

Binary of the invoice PDF as a base64-encoded, gz-compressed string.

Parameter:

Req Name Type Description
★ account string

Account which belongs to the invoice.
★ token string

Download-Token

Return Type:

array

The key 'bin' contains the base64-encoded data

account.invoice.list

Returns a list of downloadable invoices

Available for user level: adminreselleraccount

Parameter:

Req Name Type Description
★ account string

Account

Return Type:

array

This array contains further arrays. The structure is described in the following.

Name Description
invoice_id

Invoice ID
date

Invoice date
status

Invoice status
token

Download token

account.set

Eigenschaften eines Accounts verändern

Available for user level: adminreseller

Parameter:

Req Name Type Description
★ account string

Account, der verändert werden soll
password string

Neues Passwort
plan string

Tarif des Accounts

allowed values:

Value Description
basic

Grundtarif Business Basic
profi

Grundtarif Business Profi
profixl

Grundtarif Business Profi XL
reseller

Reseller-Sondertarif

memo string

Memo
address_payment_first_name string

Rechnungsvorname
address_payment_last_name string

Rechnungsnachname
address_payment_street string

Rechnungsstrasse
address_payment_zipcode string

Rechnungspostleitzahl
address_payment_town string

Rechnungsort
company string

Company Name
av_contract_accept_name string

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

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

For people with professions bound to professional discretion

Return Type:

array

Selbe Ausgabe wie account.get

auth

Performs a login (Authentication)

Parameter:

Req Name Type Description
★ user string

Username
★ pass string

Password

Return Type:

array

Creates an Auth-ID for use with API commands. This method can be executed without authentication.

Name Description
session

Session-ID / Auth-ID
level

User level of the account

context.list

Returns a list of Context-IDs and associated domains

Available for user level: adminreselleraccount

Parameter:

Req Name Type Description
★ account string

Account for which contexts are to be listed

Return Type:

array

The key is the Context-ID, and the value is a list of domains that are associated to this Context-ID

deauth

Performs a logout

This method requires a valid session (Auth-ID submitted with header).

Parameter:

No parameters expected

Return Type:

boolean

Deletes an Auth-ID (Logout)

domain.add

Adds a domain

Adds a domain to an existing account.

Available for user level: adminreselleraccount

Parameter:

Req Name Type Description
★ account string

Account to which this operation is to be applied
★ domain string

Domain name to be added
★ password string

Domain password
context_id string

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

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

Memo

Return Type:

array

same as domain.get

Should error 218 occur, then the returned data object will contain additional information for validating the domain:
Value Description
host

Hostname to contain the TXT record
txt

Value for the TXT record

domain.capabilities.set

Modifies domain emails capabilities

Available for user level: adminreselleraccountdomain

Parameter:

Req Name Type Description
★ domain string

Domain to be modified
★ capabilities array

Capabilities to set

allowed values:

Value Description
MAIL_SPAMPROTECTION

Spam/Anti-Virus Settings
MAIL_BLACKLIST

Blacklist
MAIL_BACKUPRECOVER

E-Mail Backup
MAIL_PASSWORDRESET_SMS

Password-Reset by SMS allowed

Return Type:

boolean

domain.del

Removes a domain from an account

A domain can only be removed if there are no e-mail addresses defined under that domain.

Available for user level: adminreselleraccount

Parameter:

Req Name Type Description
★ account string

Account that owns the domain
★ domain string

Domain to be deleted

Return Type:

boolean

domain.get

Returns details about a domain

Returns information about mail server configuration and other domain details.

Available for user level: adminreselleraccountdomain

Parameter:

Req Name Type Description
★ domain string

Domain to which this operation is to be applied

Return Type:

array

Name Description
domain

Domain name
status

Domain status
context_id

Context-ID
date_register

Registration date
memo

Memo
plansavailable

Available plans for mails

domain.list

Returns a list of all existing domains

Returns a list of all domains and associated e-mail addresses that exist for this account.

Available for user level: adminreselleraccount

Parameter:

Req Name Type Description
★ account string

Account to which this operation is to be applied
filter string

Search filter

Return Type:

array

This array contains further arrays. The structure is described in the following.

Name Description
domain

Domain name
count_mails

Number of e-mail addresses defined for this domain

domain.set

Modifies domain properties

Available for user level: adminreselleraccountdomain

Parameter:

Req Name Type Description
★ domain string

Domain to be modified
password string

New password
context_id string

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

Parameter available for user level (and above): account
create_new_context_id boolean

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

Parameter available for user level (and above): account
memo string

Memo

Return Type:

array

same as domain.get

domain.validate.spf

Returns SPF details about a domain

Returns information about domain SPF configuration.

Available for user level: adminreselleraccountdomain

Parameter:

Req Name Type Description
★ domain string

Domain to which this operation is to be applied

Return Type:

array

Name Description
domain

Domain name
valid

Mailbox.org SPF status
spf_should

Mailbox.org SPF string
spf_is

Domain SPF entry

hello.innerworld

Returns the string 'Hello Inner-World!' if called from a valid session

Available for user level: adminreselleraccountdomainmail

Parameter:

No parameters expected

Return Type:

string

hello.world

Returns the string 'Hello World!'

Parameter:

No parameters expected

Return Type:

string

mail.add

Adds an e-mail address

Adds a new e-mail address, which can have a dedicated inbox, be used as a forwarding address, or both.

Available for user level: adminaccountdomain

Parameter:

Req Name Type Description
★ mail string

E-mail address to be added
★ password string

Password for the new e-mail address. Not required if the parameter password_hash is present.
password_hash string

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

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

Tariff associated to the e-mail address

allowed values:

Value Description
light

Light package
standard

Standard package
premium

Premium package


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

Value Description
MAIL

Pure Mail package
MAILXL

Mail XL package
MAILXXL

MAIL XXL package
MAILXXXL

MAIL XXXL package
Office

Office package
OfficeXL

Office XL package
OfficeXXL

Office XXL package
OfficeXXXL

Office XXXL package

additional_mail_quota string

Additional quota for mail storage in gb
additional_cloud_quota string

Additional quota for cloud storage in gb
★ first_name string

First name
★ last_name string

Last name
★ inboxsave boolean

Enable saving messages in inbox
★ forwards array

Forwarding list. Leave array empty if no forwarding desired
memo string

Memo
allow_nets string

Comma separated list of allowed networks to access this mailbox
catchall boolean

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

If true then a dedicated context will be created for this e-mail address
title string

Title
birthday string

Birthday (YYYY-MM-DD)
position string

Position
department string

Department
company string

Company
street string

Street address (business)
postal_code string

ZIP or Postcode (business)
city string

Town or City (business)
phone string

Phone number (business)
fax string

Fax number (business)
cell_phone string

Mobile / Cell number (business)
recover boolean

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

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

Optional External UID
language string

locale in accordance to RFC5646, Example: en_GB

Return Type:

array

same as mail.get

mail.backup.import

Import an E-Mail-Backup into the users mailaccount

Available for user level: adminaccountdomainmail

Parameter:

Req Name Type Description
★ mail string

E-mail address for the import
★ id string

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

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

all or an IMAP foldername

Return Type:

array

same as mail.backup.list

mail.backup.list

Lists all existing E-Mail-backups

Available for user level: adminaccountdomainmail

Parameter:

Req Name Type Description
★ mail string

E-mail address to list backups for

Return Type:

array

A list of key-value pairs where the key ist a backupnumber (e.g. backup_1) and the value is a date.

mail.blacklist.add

Adds an address to the blacklist

Available for user level: adminaccountdomainmail

Parameter:

Req Name Type Description
★ mail string

E-mail address where we want to add a blacklist entry
★ add_address string

E-mail address to be added to the blacklist

Return Type:

array

same as mail.blacklist.list

mail.blacklist.del

Deletes an address from the blacklist

Available for user level: adminaccountdomainmail

Parameter:

Req Name Type Description
★ mail string

E-mail address where we want to delete a blacklist entry
★ delete_address string

E-mail address to be deleted from the blacklist

Return Type:

array

same as mail.blacklist.list

mail.blacklist.list

Lists all blacklist entries

Available for user level: adminaccountdomainmail

Parameter:

Req Name Type Description
★ mail string

E-mail address which contains the blacklist

Return Type:

array

A list of addresses

mail.capabilities.set

Modifies email capabilities

Available for user level: adminreselleraccountdomain

Parameter:

Req Name Type Description
★ mail string

Email to be modified
★ capabilities array

Capabilities to set

allowed values:

Value Description
MAIL_SPAMPROTECTION

Spam/Anti-Virus Settings
MAIL_BLACKLIST

Blacklist
MAIL_BACKUPRECOVER

E-Mail Backup
MAIL_OTP

One Time Passwords
MAIL_PASSWORDRESET_SMS

Password-Reset by SMS allowed

Return Type:

boolean

mail.del

Deletes an e-mail address

Deletes an e-mail address by temporarily moving the address to a deletion list. During that time, the address will not be available for use.

Available for user level: adminreselleraccountdomain

Parameter:

Req Name Type Description
★ mail string

E-mail address to be deleted

Return Type:

boolean

mail.get

Returns e-mail address details

Returns information about an e-mail address, including any forwarding details.

Available for user level: adminreselleraccountdomainmail

Parameter:

Req Name Type Description
★ mail string

E-mail address to be used
include_quota_usage boolean

whether to also return used mail and cloud quota

Return Type:

array

Name Description
mail

Mail address
type

Typ

possible values:

Value Description
forward

Forward to another e-mail address
inbox

Save to inbox
inboxforward

Save to inbox and forward to another e-mail address

plan

Tarif

possible values:

Value Description
MAIL

Pure Mail package
MAILXL

Mail XL package
MAILXXL

MAIL XXL package
MAILXXXL

MAIL XXXL package
Office

Office package
OfficeXL

Office XL package
OfficeXXL

Office XXL package
OfficeXXXL

Office XXXL package
light

Light package
standard

Standard package
premium

Premium package

plansavailable

Available plans

possible values:

Value Description
MAIL

Pure Mail package
MAILXL

Mail XL package
MAILXXL

MAIL XXL package
MAILXXXL

MAIL XXXL package
Office

Office package
OfficeXL

Office XL package
OfficeXXL

Office XXL package
OfficeXXXL

Office XXXL package
light

Light package
standard

Standard package
premium

Premium package

additional_mail_quota

Name Description
desc

Additional quota for mail storage in gb

additional_cloud_quota

Name Description
desc

Additional quota for cloud storage in gb

first_name

First name
last_name

Last name
inboxsave

Save to inbox boolean
require_reset_password

Passowrd reset required with next login boolean
forwards

Array of forwarding addresses
aliases

Array of alias addresses
alternate_mail

alternative e-mail address
memo

Memo
allow_nets

Comma separated list of allowed networks to access this mailbox
active

E-mail address enabled or disabled boolean
title

Title
birthday

Birthday (YYYY-MM-DD)
position

Position
department

Department
company

Company
street

Street address (business)
postal_code

ZIP or Postcode (business)
city

Town or City (business)
phone

Phone number (business)
fax

Fax number (business)
cell_phone

Mobile / Cell number (business)
language

language in RFC5646 format
capabilities

product capabilities

possible values:

Value Description
MAIL_SPAMPROTECTION

Spam/Anti-Virus Settings
MAIL_BLACKLIST

Blacklist
MAIL_BACKUPRECOVER

E-Mail Backup
MAIL_PASSWORDRESET_SMS

Password-Reset by SMS allowed

mail.list

Returns a list of e-mail addresses + configuration information

Returns a list of all e-mail addresses defined for the domain, indicating if an address is configured to save messages to an inbox, forward to another e-mail address, or do both.

Available for user level: adminreselleraccountdomain

Parameter:

Req Name Type Description
★ domain string

Domain to which this operation is to be applied
details bool

Whether to return more detailed information about mail accounts

Return Type:

array

Das Array enthält weitere Arrays. Der Aufbau der weiteren Arrays ist hier beschrieben.

Name Description
mail

Mailadresse
type

Type: forward, inbox, inboxforward

mail.passwordreset.listmethods

Returns a list of available password reset methods for the given user

Parameter:

Req Name Type Description
★ mail string

E-mail address to be used

Return Type:

array

A list of available password reset methods

mail.passwordreset.sendsms

Send a password reset token by SMS

The sent token can be used as URL parameter in https://login.mailbox.org/en/passwordrecovery/reset/<TOKEN>?token_for=bmbo

Parameter:

Req Name Type Description
★ mail string

E-mail address to be used
★ cell_phone string

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

Return Type:

boolean

mail.passwordreset.setpassword

Set a new password using a password reset token

Parameter:

Req Name Type Description
★ mail string

E-mail address to be used
★ token string

Password reset token
★ password string

The new password to be set

Return Type:

boolean

mail.register

Adds an e-mail address (using a predefined token)

A new e-mail address will be added to an existing domain and tariff, which are predefined by a token.

Parameter:

Req Name Type Description
★ token string

Token that defines the domain and tariff to be associated to the e-mail address
★ mail string

E-mail address to be created
★ password string

Password for the new e-mail address
alternate_mail string

Alternative e-mail address
★ first_name string

First name
★ last_name string

Last name
lang string

Welcome e-mail language (default: en)

allowed values:

Value Description
de

Deutsch
en

English
fr

Français

Return Type:

boolean

mail.set

Modifies e-mail address properties

Available for user level: adminreselleraccountdomainmail

Parameter:

Req Name Type Description
★ mail string

E-mail address to be modified
password string

New password
password_hash string

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

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

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

E-mail tariff

allowed values:

Value Description
MAIL

Pure Mail package
MAILXL

Mail XL package
MAILXXL

MAIL XXL package
MAILXXXL

MAIL XXXL package
Office

Office package
OfficeXL

Office XL package
OfficeXXL

Office XXL package
OfficeXXXL

Office XXXL package
light

Light package
standard

Standard package
premium

Premium package


Parameter available for user level (and above): domain
additional_mail_quota string

Additional quota for mail storage in gb
additional_cloud_quota string

Additional quota for cloud storage in gb
first_name string

First name
last_name string

Last name
inboxsave boolean

Enable saving messages in inbox
forwards array

Forwarding list. Leave array empty if no forwarding desired
aliases array

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
alternate_mail string

alternative e-mail address
memo string

Memo
allow_nets string

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

If set to false then the e-mail address will be disabled
title string

Title
birthday string

Birthday (YYYY-MM-DD)
position string

Position
department string

Department
company string

Company
street string

Street address (business)
postal_code string

ZIP or Postcode (business)
city string

Town or City (business)
phone string

Phone number (business)
fax string

Fax number (business)
cell_phone string

Mobile / Cell number (business)
uid_extern string

Optional External UID
language string

locale in accordance to RFC5646, Example: en_GB

Return Type:

array

same as mail.get. If a tariff change to a lower tariff produces an error because of tariff limitations, you will get an errorcode 398. In that case, the error response also contains a data attribute, which contains an array of reasons, why the downgrade didn't work:

Name Description
capability

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

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

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

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

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

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

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

This change can only be done by the team master
noTeamCombinationOldAndNewTariff

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

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

mail.spamprotect.get

Read spamprotection settings

more information on spam filter settings: https://kb.mailbox.org/display/MBOKBEN/Customizing+your+mailbox.org+spam+filter+settings

Available for user level: adminaccountdomainmail

Parameter:

Req Name Type Description
★ mail string

E-mail address for reading spamprotection settings

Return Type:

array

Name Description
greylist

Greylisting

possible values:

Value Description
0

deactivated
1

activated

smtp_plausibility

SMTP plausibility check

possible values:

Value Description
0

deactivated
1

activated

rbl

Real-time Blacklist (RBL)

possible values:

Value Description
0

deactivated
1

activated

bypass_banned_checks

Executable files as attachments

possible values:

Value Description
0

deactivated
1

activated

tag2level

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

reject or redirect spam e-mails

possible values:

Value Description
reject

reject
route

Flag & redirect

route_to

IMAP foldername, to which spam e-mails will be redirected if killevel = route
imap_folders

an array of the user's IMAP foldernames

mail.spamprotect.set

Sets the spamprotection settings

Available for user level: adminaccountdomainmail

Parameter:

Req Name Type Description
★ mail string

E-mail address for setting spamprotection settings
★ greylist string

Greylisting

allowed values:

Value Description
0

deactivated
1

activated

★ smtp_plausibility string

SMTP plausibility check

allowed values:

Value Description
0

deactivated
1

activated

★ rbl string

Real-time Blacklist (RBL)

allowed values:

Value Description
0

deactivated
1

activated

★ bypass_banned_checks string

Executable files as attachments

allowed values:

Value Description
0

deactivated
1

activated

★ tag2level string

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

reject or redirect spam e-mails

allowed values:

Value Description
reject

reject
route

Flag & redirect

★ route_to string

IMAP foldername, to which spam e-mails will be redirected if killevel = route

Return Type:

array

same as mail.spamprotect.get

mail.vacation.delete

deletes the settings of an automatic mail response

deletes the settings of an automatic mail response if one is active

Available for user level: adminreselleraccountdomainmail

Parameter:

Req Name Type Description
★ mail string

E-mail address to delete the active automatic mail response for

Return Type:

array

Name Description
result

true on success
code

integer code on error
message

error message on error

mail.vacation.get

gets the settings of an automatic mail response

gets the settings of an automatic mail response if one is active

Available for user level: adminreselleraccountdomainmail

Parameter:

Req Name Type Description
★ mail string

E-mail address to get the active automatic mail response for

Return Type:

array

Name Description
message

message containing info that an automatic mail response is not active
subject

subject of the active automatic mail response
body

body of the active automatic mail response
additional_mail_addresses

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

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

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

mail.vacation.set

sets an automatic mail response

sets an automatic mail response with start and end date

Available for user level: adminreselleraccountdomainmail

Parameter:

Req Name Type Description
★ mail string

E-mail address to set the automatic mail response for
★ subject string

subject of the automatic mail response
body string

message body of the automatic mail response
★ start_date string

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

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

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

Return Type:

array

Name Description
result

true on success
code

integer code on error
message

error message on error

mailinglist.add

Adds a mailing list

Adds a new mailing list.

Available for user level: adminaccount

Parameter:

Req Name Type Description
★ mailinglist string

★ password string

★ account string

adminmail string

Return Type:

boolean

Returns true on success and an error code otherwise

mailinglist.del

Deletes a mailing list

Deletes a mailing list

Available for user level: adminaccount

Parameter:

Req Name Type Description
★ mailinglist string

★ account string

Return Type:

boolean

True if deletion succeeded, an error code otherwise

mailinglist.get

###short###

Parameter:

Req Name Type Description
★ mailinglist string

★ account string

Return Type:

array

Name Description
mailinglist

Mailing list name
status

Mailingl ist status
adminmail

Mailing list admin mail

mailinglist.list

Returns all lists of the account

Returns all lists of the account with name and status

Available for user level: adminaccount

Parameter:

Req Name Type Description
★ account string

Return Type:

Array

All mailing lists of the account and their status

mailinglist.set

Edits a mailing list

Edits an existing mailing list.

Available for user level: adminaccount

Parameter:

Req Name Type Description
★ mailinglist string

★ account string

password string

adminmail string

Return Type:

boolean

Returns true on success and an error code otherwise

search

Searches in accounts, domains and e-mails

Delivers a results list containing the names of all accounts, domains and e-mail addresses.

Parameter:

Req Name Type Description
★ query string

Search query
get_account_summary bool

if the result should contain more infos about found accounts

Return Type:

array

Separated into results for accounts, domains, and e-mail addresses.

Name Description
accounts

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

An array of domains
emails

An array of e-mails

test.accountallowed

Confirms if the account can be administrated using the current ACLs

Parameter:

Req Name Type Description
★ account string

Account

Return Type:

boolean

test.domainallowed

Confirms if the domain can be administrated using the current ACLs

Parameter:

Req Name Type Description
★ domain string

Domain

Return Type:

boolean

utils.validator

Performs a validation

Parameter:

Req Name Type Description
★ value string

Value to be validated
allow_mail_extensions boolean

allow mail extensions with '+'
★ type string

Description of the validator

allowed values:

Value Description
hostname

Hostname
domain

Domain
mailhost

Mailhost
mail

E-mail address
account

Account
pass

Password (New password)
pass2

Password (Authentication)
memo

Memo
user

Username
contextid

Context-ID
name

Name (First name, last name, ...)

Return Type:

boolean