Class CDomain
- api_AContainer
-
CDomain
Methods summary
public
|
|
public
boolean
|
|
public
array
|
|
public static
array
|
|
public
boolean
|
|
public
|
|
public
array
&
|
|
public
array
|
|
public
array
|
Properties summary
protected
array
|
$aFolders
|
Magic properties
public
integer
|
$IdDomain
ID of the domain in the database. |
public
integer
|
$IdTenant
|
public
boolean
|
$IsDisabled
Set to true if the domain was disabled. |
public
string
|
$Name
Domain name. |
public
string
|
$Url
URL pattern to be matched against actual URL for detecting domain used. |
public
boolean
|
$OverrideSettings
Set to true if domain properties should override default domain settings. |
public
boolean
|
$IsInternal
Set to true for domain hosted by mailserver bundle. |
public
boolean
|
$IsDefaultDomain
Set to true if object instance is created for the default domain. |
public
string
|
$SiteName
Text to be displayed in web browser tab/window title. |
public
string
|
$DefaultLanguage
Language used by default, name should match the name of language file under i18n dir with extension omitted. |
public
integer
|
$DefaultTimeZone
Default timezone offset value |
public
integer
|
$DefaultTimeFormat
Set to ETimeFormat::F12 or ETimeFormat::F24 to use 12-hour or 24-hour time format by default, respectively. |
public
integer
|
$DefaultDateFormat
Accepted values: EDateFormat::DD_MONTH_YYYY - DD Month YYYY; EDateFormat::MMDDYYYY - MM/DD/YYYY; EDateFormat::DDMMYYYY - DD/MM/YYYY; EDateFormat::MMDDYY - MM/DD/YY; EDateFormat::DDMMYY - DD/MM/YY. |
public
boolean
|
$AllowRegistration
|
public
boolean
|
$AllowPasswordReset
|
public
integer
|
$IncomingMailProtocol
Legacy value, only IMAP is currently supported (value is EMailProtocol::IMAP4). |
public
string
|
$IncomingMailServer
IP address or hostname of incoming mail server. |
public
integer
|
$IncomingMailPort
Port number of incoming mail server, typical values are 143 (non-SSL) or 993 (SSL). |
public
boolean
|
$IncomingMailUseSSL
Set to true if connection to incoming mail server must be made via dedicated SSL port. |
public
string
|
$OutgoingMailServer
IP address or hostname of outgoing mail server. |
public
integer
|
$OutgoingMailPort
Port number of outgoing mail server, typical values are 25/587 (non-SSL) or 465 (SSL). |
public
integer
|
$OutgoingMailAuth
Accepted values: ESMTPAuthType::NoAuth for no authentication; ESMTPAuthType::AuthSpecified for using fixed login/password for SMTP authentication; ESMTPAuthType::AuthCurrentUser for using incoming mail credentials for that. |
public
string
|
$OutgoingMailLogin
Username for SMTP authentication. Applied if OutgoingMailAuth is set to ESMTPAuthType::AuthSpecified value. |
public
string
|
$OutgoingMailPassword
Password for SMTP authentication. Applied if OutgoingMailAuth is set to ESMTPAuthType::AuthSpecified value. |
public
boolean
|
$OutgoingMailUseSSL
Set to true if connection to outgoing mail server must be made via dedicated SSL port. |
public
integer
|
$OutgoingSendingMethod
|
public
integer
|
$UserQuota
|
public
integer
|
$AutoCheckMailInterval
Interval (in minutes) for invoking automated checkmail, setting its value to 0 disables the feature. |
public
string
|
$DefaultSkin
Skin used by default. |
public
integer
|
$MailsPerPage
Number of messages to be displayed per page in message list. |
public
boolean
|
$AllowUsersChangeInterfaceSettings
Set to true if users can change interface options. |
public
boolean
|
$AllowUsersChangeEmailSettings
Set to true if users can change mailserver access configuration details. Most of those settings, however, are only available under default domain. |
public
boolean
|
$AllowUsersAddNewAccounts
Set to true if users are allowed to add new accounts to their primary ones. |
public
boolean
|
$AllowNewUsersRegister
|
public
boolean
|
$AllowOpenPGP
|
public
integer
|
$Layout
Legacy value. |
public
integer
|
$SaveMail
|
public
integer
|
$ContactsPerPage
Number of address book entries displayed per page. |
public
integer
|
$GlobalAddressBook
|
public
boolean
|
$CalendarShowWeekEnds
Accepted values: true or false. |
public
integer
|
$CalendarWorkdayStarts
Define work day start time, respectively. |
public
integer
|
$CalendarWorkdayEnds
Define work day time, respectively. |
public
boolean
|
$CalendarShowWorkDay
Accepted values: true or false. |
public
integer
|
$CalendarWeekStartsOn
Accepted values: ECalendarWeekStartOn::Saturday, ECalendarWeekStartOn::Sunday, ECalendarWeekStartOn::Monday. |
public
integer
|
$CalendarDefaultTab
Accepted values: ECalendarDefaultTab::Day, ECalendarDefaultTab::Week, ECalendarDefaultTab::Month. |
public
boolean
|
$DetectSpecialFoldersWithXList
By default, WebMail detects special folders (also known as system ones) based on their name in IMAP folder tree. In case if IMAP server supports XLIST extension, setting this to true allows for detecting special folders even if they're called in non-standard (e.g. localized) manner. |
public
string
|
$ExternalHostNameOfLocalImap
Mobile sync configuration option. Only applies to default domain configuration of WebMail Pro. |
public
string
|
$ExternalHostNameOfLocalSmtp
Mobile sync configuration option. Only applies to default domain configuration of WebMail Pro. |
public
string
|
$ExternalHostNameOfDAVServer
Mobile sync configuration option. Only applies to default domain configuration of WebMail Pro. |
public
boolean
|
$UseThreads
Set to true if message threading needs to be enabled. Mail server has to support this feature, of course. |
public
boolean
|
$AllowWebMail
Set to true to allow accessing webmail interface. |
public
boolean
|
$AllowContacts
Set to true to enable address book functionality. |
public
boolean
|
$AllowCalendar
Set to true to enable calendar functionality (WebMail Pro only). |
public
boolean
|
$AllowFiles
|
public
boolean
|
$AllowHelpdesk
|
public
string
|
$DefaultTab
|
public
string
|
$PasswordMinLength
|
public
boolean
|
$PasswordMustBeComplex
|
public
boolean
|
$IsDefaultTenantDomain
|