getSettingsRequest

Returns all user settings. The getSettingsResponse provides groups of settings. The groups are similar to the Windows client groups

Request

<getSettingsRequest>
   <id" type="string"/>
</getSettingsRequest>

Response

<getSettingsResponse>
   <settings type="types:Settings"/>
   <status type="types:Status"/>
</getSettingsResponse>

Elements

id

Specifies the name of the setting. If blank, all settings are returned. Can contain the name of a group of settings or of an individual setting.

settings

Specifies the settings for a user. Each setting has a field and a value. It also has a locked element to signify that the setting cannot be changed because the administrator has locked down the setting.

code

Returns the error number related to the event. 0 indicates that the request was successful.

status

Returns the success or failure of the method.

Remarks

You can get all user settings, a group of settings, or an individual setting. If you want to retrieve all the settings for a user, don't add a value for the ID. If you want to retrieve a group of settings for a user, specify the group name in the setting. For example, to get all the settings in the Environment Settings, specify EnvironmentSettings for the ID. If you want to retrieve an individual setting, specify the name of the setting in the ID.

Be aware that the GroupWise clients hide some of the complexities of client settings. Make sure you understand the consequences of changing a setting before calling getSettingsRequest.

Example

<getSettingsRequest/> 

<getSettingsResponse> 
   <settings> 
      <group type="EnvironmentSettings"> 
         <setting> 
            <field>allowSharedFolders</field> 
            <value>1</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>settingsLanguage</field> 
            <value>US</value> 
         </setting> 
         <setting> 
            <field>allowSharedAddressBooks</field> 
            <value>1</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>allowPOP_IMAPAccounts</field> 
            <value>1</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>allowNNTPAccounts</field> 
            <value>1</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>showIMPresence</field> 
            <value>1</value> 
         </setting> 
      </group> 
      <group type="TimezoneSettings"> 
         <setting> 
            <field>daylightTime</field> 
            <value>1</value> 
         </setting> 
         <setting> 
            <field>daylightBeginDate</field> 
            <value>0000-04-02</value> 
         </setting> 
         <setting> 
            <field>daylightEndDate</field> 
            <value>0000-10-29</value> 
         </setting> 
         <setting> 
            <field>daylightChange</field> 
            <value>01:00</value> 
         </setting> 
         <setting> 
            <field>daylightHemisphere</field> 
            <value>Northern</value> 
         </setting> 
         <setting> 
            <field>GMTOffset</field> 
            <value>-7:00</value> 
         </setting> 
         <setting> 
            <field>daylightFormula</field> 
            <value>00000105</value> 
         </setting> 
      </group> 
      <group type="MailMessageSettings"> 
         <setting> 
            <field>mailPriority</field> 
            <value>Standard</value> 
         </setting> 
         <setting> 
            <field>notifyRecipient</field> 
            <value>1</value> 
         </setting> 
         <setting> 
            <field>mailReturnOpen</field> 
         </setting> 
         <setting> 
            <field>mailReturnCompleted</field> 
         </setting> 
         <setting> 
            <field>mailReturnDelete</field> 
         </setting> 
         <setting> 
            <field>mailStatusInfo</field> 
            <value>DeliveredAndOpened</value> 
         </setting> 
         <setting> 
            <field>mailReplyRequested</field> 
            <value>None</value> 
         </setting> 
         <setting> 
            <field>mailExpireDays</field> 
            <value>0</value> 
         </setting> 
         <setting> 
            <field>mailAutoDelete</field> 
            <value>0</value> 
         </setting> 
      </group> 
      <group type="AppointmentMessageSettings"> 
         <setting> 
            <field>appointmentPriority</field> 
            <value>Standard</value> 
         </setting> 
         <setting> 
            <field>appointmentReturnOpen</field> 
         </setting> 
         <setting> 
            <field>appointmentReturnAccept</field> 
         </setting> 
         <setting> 
            <field>appointmentReturnDelete</field> 
         </setting> 
         <setting> 
            <field>appointmentStatusInfo</field> 
            <value>Full</value> 
         </setting> 
         <setting> 
            <field>appointmentDefaultLength</field> 
            <value>01:00</value> 
         </setting> 
      </group> 
      <group type="TaskMessageSettings"> 
         <setting> 
            <field>taskPriority</field> 
            <value>Standard</value> 
         </setting> 
         <setting> 
            <field>taskReturnOpen</field> 
         </setting> 
         <setting> 
            <field>taskReturnAccept</field> 
         </setting> 
         <setting> 
            <field>taskReturnCompleted</field> 
         </setting> 
         <setting> 
            <field>taskReturnDelete</field> 
         </setting> 
         <setting> 
            <field>taskStatusInfo</field> 
            <value>Full</value> 
         </setting> 
      </group> 
      <group type="NoteMessageSettings"> 
         <setting> 
            <field>notePriority</field> 
            <value>Standard</value> 
         </setting> 
         <setting> 
            <field>noteReturnOpen</field> 
         </setting> 
         <setting> 
            <field>noteReturnDelete</field> 
         </setting> 
         <setting> 
            <field>noteStatusInfo</field> 
            <value>DeliveredAndOpened</value> 
         </setting> 
         <setting> 
            <field>noteReturnAccept</field> 
         </setting> 
      </group> 
      <group type="AdvancedSettings"> 
         <setting> 
            <field>sendSecurity</field> 
            <value>Normal</value> 
         </setting> 
         <setting> 
            <field>concealedSubject</field> 
            <value>0</value> 
         </setting> 
         <setting> 
            <field>delayDelivery</field> 
            <value>-1</value> 
         </setting> 
         <setting> 
            <field>outboxInsert</field> 
            <value>1</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>itemConversions</field> 
            <value>0</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>routePasswordRequired</field> 
            <value>0</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>asteriskSendRestriction</field> 
            <value>postOffice</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>autoSpellCheck</field> 
            <value>0</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>addSignature</field> 
            <value>3</value> 
         </setting> 
         <setting> 
            <field>encryptMessages</field> 
            <value>0</value> 
            <locked>1</locked> 
          </setting> 
         <setting> 
            <field>disallowSMIME</field> 
            <value>0</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>internetStatusTrackingSettings</field> 
         </setting> 
         <setting> 
            <field>simpleForward</field> 
            <value>0</value> 
         </setting> 
         <setting> 
            <field>allowRuleReplyMoreThanOnce</field> 
            <value>0</value> 
         </setting>  
      </group> 
      <group type="BusySettings"> 
         <setting> 
            <field>busyStartTime</field> 
            <value>08:00</value> 
         </setting> 
         <setting> 
            <field>busyEndTime</field> 
            <value>17:00</value> 
         </setting> 
         <setting> 
            <field>busyInterval</field> 
            <value>15</value> 
         </setting> 
         <setting> 
            <field>busyDays</field> 
            <value>Monday,Tuesday,Wednesday,Thursday,Friday</value> 
         </setting> 
         <setting> 
            <field>busyExtended</field> 
            <value>0</value> 
         </setting> 
         <setting> 
            <field>busySearchRange</field> 
            <value>7</value> 
         </setting> 
      </group> 
      <group type="CalendarViewSettings"> 
         <setting> 
            <field>appointmentIncludeSelf</field> 
            <value>1</value> 
         </setting> 
         <setting> 
            <field>startOfWorkday</field> 
            <value>08:00</value> 
         </setting> 
         <setting> 
            <field>endOfWorkday</field> 
            <value>17:00</value> 
         </setting> 
         <setting> 
            <field>workdays</field> 
            <value>Monday,Tuesday,Wednesday,Thursday,Friday</value> 
         </setting> 
      </group> 
      <group type="DiscardSettings"> 
         <setting> 
            <field>mailDelete</field> 
            <value>manualDeleteArchive</value> 
         </setting> 
         <setting> 
            <field>appointmentDelete</field> 
            <value>manualDeleteArchive</value> 
         </setting> 
         <setting> 
            <field>trashPurge</field> 
            <value>autoPurgeAfterTrashDays</value> 
         </setting> 
         <setting> 
            <field>trashDays</field> 
            <value>7</value> 
         </setting> 
         <setting> 
            <field>messageSendLimit</field> 
            <value>0</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>boxThresholdLimit</field> 
            <value>0</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>boxSizeLimit</field> 
            <value>0</value> 
            <locked>1</locked> 
         </setting> 
         <setting> 
            <field>enableBoxThresholdNotificaion</field> 
            <value>0</value> 
         </setting> 
         <setting> 
            <field>enableBoxSizeNotificaion</field> 
            <value>0</value> 
         </setting> 
      </group> 
      <group type="AppointmentViewSettings"> 
         <setting> 
            <field>appointmentAlarmSet</field> 
            <value>1</value> 
         </setting> 
         <setting> 
            <field>appointmentAlarmMinutes</field> 
            <value>5</value> 
         </setting> 
         <setting> 
            <field>allDayEventAlarmSet</field> 
            <value>0</value> 
         </setting> 
         <setting> 
            <field>allDayEventAlarmMinutes</field> 
            <value>720</value> 
         </setting> 
      </group> 
      <group type="SPAMSettings"> 
         <setting> 
            <field>useBlockList</field> 
            <value>1</value> 
         </setting> 
         <setting> 
            <field>useJunkList</field> 
            <value>1</value> 
         </setting> 
         <setting> 
            <field>usePAB</field> 
            <value>0</value> 
         </setting> 
         <setting> 
            <field>persistence</field> 
            <value>14</value> 
         </setting> 
         <setting> 
            <field>autoDelete</field> 
            <value>0</value> 
         </setting> 
         <setting> 
            <field>iCalUsePAB</field> 
            <value>0</value> 
         </setting> 
      </group> 
   </settings> 
   <status> 
      <code>0</code> 
   </status> 
</getSettingsResponse>