Folder.ListChild

Retrieves child folders for the specified folder. The child folders are not expanded.

Parameters

User.context (Required)

Specifies the context identifier for this user's session.

Folder.id or Folder.drn (Required)

Specifies the folder identifier or Folder DRN of the parent folder. Only the unexpanded child folders are returned.

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 returned 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 level.

Folder[n].type

Specifies the type of the nth item:

  • 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. Its children are included in the folder list.

Example

<A href="/servletwebacc?User.context=xyz&action=
Folder.ListChild&Folder.id=10"> List Child </A>