Folder

Is the base object for all folders.

Syntax

<Folder>
  <extension base="Item">
  <parent type="uid"/>
  <element ref="description"/>
  <count type="int"/>
  <hasUnread type="boolean"/>
  <unreadCount type="int"/>
  <element ref="sequence"/>
  <calendarAttribute type="CalendarFolderAttribute"/>
  <URL type="string"/>
  <frequency type="int"/>
  <displaySettings type="FolderDisplaySettings"/>
  <displayReference type="uid"/>
  <flags type="FolderFlags"/>
</Folder>

Definitions

parent

Specifies the ID of the parent folder.

description

Specifies the description of the folder.

count

Specifies the number of items in a folder.

The count is not returned on the Sent Items folder, folders shared to me, and Query folders. The reason for not returning the counts on the above folder types is because we need to read all the items and then discard the results to get the count. The resource cost was deemed to high.

hasUnread

Specifies if there are unread items in the folder.

unreadCount

Specifies the number of unread items in a folder.

sequence

Specifies the location or sequence of a folder in a folder list.

settings

Is not currently used.

calendarAttribute

Specifies the calendarAttribute element.

URL

Specifies the URL assigned to a folder. URL’s can be assigned to a panel.

frequency

Specifies the refresh frequency on a folder. Frequency can be assigned on a panel if it applies.

displaySettings

Specifies the folder of panel’s display settings.

displayRefernce

Reference to display settings.

--For GroupWise 8.0 SP1 and later.

flags

Specifies control flags of the folder.

--For GroupWise 2012 and later.