pem.exchange.getMailboxInfo

This method is supported by Operations starting from version 2.6.5

This method returns properties of Mailbox.

The method has the following input parameters:

Name

Type

Short Description

mailbox_id

int

The ID of Mailbox.

The method has the following output parameters:

Name

Type

Short Description

mailbox_id

int

The ID of Mailbox.

user_id

int

The ID of Service User which corresponds to the Mailbox.

login

string

The login to access the Mailbox.

display_name

string

The "Display Name" property of Mailbox.

alias

string

The alias of Mailbox.

owa

boolean

Whether the Outlook Web Access (OWA) support is enabled.

mapi

boolean

Whether the access over Outlook support is enabled.

active_sync

boolean

Whether the Active Sync support is enabled.

imap4

boolean

Whether an access to Mailbox over IMAP4 support is enabled.

pop3

boolean

Whether an access to Mailbox over POP3 support is enabled.

size

int

Storage size (in Kilobytes) occupied by the mailbox contents.

warning_limit

int

Storage size (in Kilobytes) the mailbox can occupy before a warning message is sent to the mailbox owner.

prohibit_send_limit

int

Storage size (in Kilobytes) the mailbox can occupy before the system prevents the mailbox owner from sending more messages.

size_limit

int

Maximum storage size (in Kilobytes) the mailbox can occupy before the system prevents the mailbox owner from sending and receiving more messages.

incoming_item_max_size

int

Maximum size of message (in Kilobytes) that can be received to the mailbox.

outgoing_item_max_size

int

Maximum size of message (in Kilobytes) that can be sent from the mailbox.

recipient_list_max_size

int

Maximum number of recipients the mailbox owner can send a message to.

message_retention

int

The period indicating how long the deleted items should be kept (days).

show_in_address_book

boolean

Whether the "Show in address book" Mailbox property is enabled. If the property is disabled, the Mailbox will not be visible in the address books or search queries.

status

int

Mailbox status. The list of possible values is the following:

  • 0 – Ready.
  • 1 – Creating.
  • 2 – Deleting.
  • 3 – Updating.

primary_email_address

string

Primary e-mail address of Mailbox.

[pop3_server]

string

POP3 server DNS name of Mailbox. POP3 server DNS name is returned if POP3 is enabled for Mailbox.

[imap_server]

string

IMAP server DNS name of Mailbox. IMAP server DNS name is returned if IMAP is enabled for Mailbox.

[smtp_server]

string

SMTP server DNS name of Mailbox. SMTP server DNS name is returned if POP3 or IMAP is enabled for Mailbox.

[exchange_home_server]

string

Mail-store server NetBIOS name of Mailbox. Mail-store server NetBIOS name is returned if the Outlook access is enabled for Mailbox.

[exchange_proxy_server]

string

Front-end (CAS) server DNS name of Mailbox. Front-end (CAS) server DNS name is returned if the Outlook access is enabled for Mailbox.

[owa_url]

string

OWA URL of Mailbox. OWA URL is returned if OWA is enabled for Mailbox.

windows_domain

string

Mailbox Windows Domain DNS name.

exchange_version

int

Exchange server version. Possible values are the following:

  • 2013 – MS Exchange 2013

store_display_name

string

Mailbox Store Display Name in the <host name>/<store name> format.

[mailbox_template]

string

The name of the Mailbox Template. This parameter is returned, if a Mailbox was created on the basis of a certain Mailbox Template.

Note: This method can also be called under Reseller permissions.