View source for Domain Webmail Settings (Rest API)

== v1 - Current==

This resource supports reading and setting various Webmail Settings on a specified domain.
 
'''These settings are only used for domains that have Rackspace Email services'''. Changing these values will have no effect on Exchange only domains.

=== Data Model ===

==== Webmail Settings ====

{| class="wikitable"
!''Field Name''
!''Data Type''
!''Verbs''
!''Description''
|-
| ChatEnabled
| Bool
| GET, PUT
| Whether the Webmail Chat feature is enabled for the domain and shows up in Webmail
|-
| DropboxEnabled
| Bool
| GET, PUT
| Whether the Dropbox feature is enabled for the domain and shows up in Webmail 
|-
| PasswordResetEnabled
| Bool
| GET, PUT
| Whether users are allowed to set up their own reset scheme. Regardless of setting, account admins may always reset their password through the Control Panel or API.
|-
| User24HourTime
| Bool
| GET, PUT
| Whether to show time in 24 hour time. Setting this to false results in 12 hour time being shown in Webmail.
|-
| MultiFactorSetting
| String
| GET, PUT
| Determines whether users are allowed to or are forced to set up Multi-Factor Authentication for their mailbox. Valid options are "optional", "off", or "forced".
|-
| DropboxEnabled
| Bool
| GET, PUT
| Whether the Dropbox feature is enabled for the domain and shows up in Webmail 
|-
| Language
| String
| GET, PUT
| Determines the default language of the Webmail interface for mailboxes. The supported list of language codes is appended below this table.
|-
| DateFormat
| String
| GET, PUT
| Determines the formatting of dates in Webmail. Valid options are "1" for mm/dd/yy or "2" for dd/mm/yy.
|-
| TimeZone
| String
| GET, PUT
| Determines the default timezone of the Webmail interface for mailboxes. The supported list of timezone strings is appended below this table.
|}

Supported languages for Webmail are:
{| class="wikitable"
!''Language''
!''Language Code''
|-
| English
| en_US
|-
| Spanish
| es_ES
|-
| French
| fr_FR
|-
| Chinese
| zh_CN
|-
| German
| de_DE
|-
| Greek
| de_DE
|-
| Italian
| it_IT
|-
| Japanese
| ja_JP
|-
| Polish
| pl_PL
|-
| Portuguese
| pt_BR
|-
| Thai
| th_TH
|}

Supported timezones for Webmail are any valid PHP timezones: https://www.php.net/manual/en/timezones.php

PHP supports various formats, some examples include

<pre>
  Etc/GMT+10
  Etc/UTC
  US/Eastern
  EST
  America/Buenos_Aires
</pre>

----

=== Read ===

{| class="wikitable"
! Verb
| GET
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/webmailSettings/
|-
! Description
| Returns Webmail Settings for the specified domain.
|-
! Model
| [[#Webmail_Settings|Webmail Settings]]
|}

HTTP Codes

{| class="wikitable"
! Code
! Condition
|-
| 200 OK
| The information was successfully retrieved.
|-
| 404 Not Found
| The domain does not exist.
|}

<pre>
Request:
GET https://api.emailsrvr.com/v1/domains/example.com/webmailSettings

Response:
200 OK
{
  "ChatEnabled": true,
  "DropboxEnabled": true,
  "PasswordResetEnabled": false,
  "Use24HourTime": true,
  "MultiFactorSetting": "forced",
  "Language": "en_US",
  "DateFormat": "1",
  "TimeZone": "US/Eastern"
}
</pre>

----

=== Update ===

{| class="wikitable"
! Verb
| PUT
|-
! URL Format
| /v1/customers/{customer account number}/domains/{domain name}/webmailSettings
|-
! Description
| Updates the webmail settings for a particular domain
|-
! Model
| [[#Webmail_Settings|Webmail Settings]]
|}

HTTP Codes

{| class="wikitable"
! Code
! Condition
|-
| 204 No Content
| The request has been accepted and will be processed.
|-
| 404 Not Found
| The domain does not exist.
|}

<pre>
Request:
PUT https://api.emailsrvr.com/v1/domains/example.com/webmailSettings
{
    "ChatEnabled": true,
    "DropboxEnabled": true,
    "PasswordResetEnabled": false,
    "Use24HourTime": true,
    "MultiFactorSetting": "forced",
    "Language": "es_ES",
    "DateFormat": "1",
    "TimeZone": "US/Eastern"
}

Response:
204 No Content
</pre>

It also supports partial payloads, for example, just changing the Multi-Factor Authentication setting:

<pre>
Request:
PUT https://api.emailsrvr.com/v1/domains/example.com/webmailSettings
{
    "MultiFactorSetting": "optional"
}

Response:
204 No Content
</pre>