Folder.List

Retrieves a list of folders.

Parameters

Folder.expandAll

Specifies to display all folders.

User.context (Required)

Specifies the context identifier for this user’s session.

Find.Folders.clear

Specifies to clear all selected folders (used with the Find feature) if true.

Return Values

Value

Description

Folder.count

Number of folders returned.

Folder[n].id

Folder ID of the nth folder.

Folder[n].drn

Folder DRN of the nth folder.

Folder[n].name

Name of the nth folder.

Folder[n].level

Level of the nth folder. A child folder has a level that is one greater than its parent’s level.

Folder[n].parentId

Folder ID of the parent for the nth folder.

Folder[n].type

Type of the nth folder:

  • Folder.NORMAL
  • Folder.SENTITEMS
  • Folder.TASKLIST
  • Folder.QUERY
  • Folder.USER
  • Folder.UNIVERSAL
  • Folder.TRASH
  • Folder.CABINET
  • Folder.SHARED
  • Folder.UNOPENED
  • Folder.CHECKLIST
  • Folder.DOCUMENT Special backward compatibility case with GroupWise 5.2.
  • Folder.SHAREDREF If this is a shared folder reference, display the user's rights to the folder:

Folder[n].Rights.delete Delete rights to the nth folder.

Folder[n].Rights.post Post or create rights to the nth folder.

Folder[n].inRule

1 specifies the nth folder is referenced within a rule.

Folder[n].hasSubfolders

1 specifies the nth folder has subfolders.

Folder[n].isExpanded

1 specifies the nth folder is expanded and its children are included in the folder list.

Example

servlet/webacc?User.contet=xyz&action=Folder.List