Skip to content

4. Object orientation

Hendrik Schlange edited this page Jun 7, 2026 · 8 revisions

The package includes the following object classes to help with object oriented programming:

Account

This object represents a mailbox Business account and its attributes.

Creating an Account object

The object can be either created manually or via the helper function account_get_object.

Available attributes

Attribute Type
Name String
account String
type String
status String
plan String
old_customer String
language String
company String
ustid String
address_main Dictionary with the main address
address_payment Dictionary with the payment address
bank Dictionary with the bank data
contact Dictionary with the customer data
monthly_fee String
invoice_type String
av_contract Dictionary with the name and date of signing the data processing agreement
tarifflimits Dictionary containing the limits associated with the account, e.g. allowed Standard mailboxes
dta_allowed String
payment_type String

Getters and setters

Getter and setter functions are available for each attribute.

Invoice

This object represents a mailbox Business invoice and its attributes.

Creating an Invoice object

The object can be either created manually or via the helper function account_invoice_get_object.

Available attributes

Attribute Type
account String
invoice_id String
status String
date String
token String
csv String
pdf String
xml String

Getters and setters

Getter and setter functions are available for each attribute.

Mail

This object represents a mailbox Business mailbox and its attributes.

Creating a Mail object

The object can be either created manually or via the helper function mail_get_object.

Available attributes

Attribute Type
mail String
password String
password_hash String
same_password_allowed Boolean
require_password_reset Boolean
plan String
additional_mail_quota Integer
additional_cloud_quota Integer
first_name String
last_name String
inboxsave Boolean
forwards String
aliases String
alternate_mail String
memo String
allow_nets String
active Boolean
title String
birthday String
position String
department String
company String
street String
postal_code String
city String
phone String
fax String
cell_phone String
uid_extern String
language String
capabilities List
creation_date String
uid String
type String
plansavailable List

Getters and setters

Getter and setter functions are available for each attribute.