Folder.Open

Retrieves the message list for the specified folder.

Parameters

Folder.id or Folder.drn

Specifies the identifier or DRN of the folder to open. The last accessed folder is used if this parameter is not present.

Folder.queryCount

Specifies how many items to retrieve.

Folder.queryType

Specifies whether to query from the beginning of the list or the current position. If this parameter is not specified, the query starts at the beginning of the list.

  • Item.queryFirst Begin item list with the first item in the folder (Default)
  • Item.queryNext Begin folder list where the last list of folders items ended
User.context (Required)

Specifies the context identifier for this user’s session.

Item.Accept.ShowAs

Specifies one of the following acceptance levels for an appointment:

  • 1 Busy
  • 2 Free
  • 4 Out of office
  • 8 Tentative

Return Values

Value

Description

Folder.hasMore

1 specifies there are more messages than what was returned.

Folder.hasDraft

1 specifies that the returned list of items contains one or more draft items.

Folder.id

ID of the folder.

Folder.drn

DRN of the folder.

Folder.name

Name of the folder.

Folder.level

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

Folder.parentId

Folder ID of the parent folder.

Folder.queryCount

Display this number of items in the folder.

Folder.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.CHECKLIST
  • Folder.UNOPENED
  • Folder.DOCUMENT Special backward compatibility 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.inRule

1 indicates the nth folder is referenced within a rule.

Folder.hasSubfolders

1 indicates the nth folder has subfolders.

Folder.isExpanded

1 indicates the nth folder is expanded. Its children are included in the folder list.

Item.count

Number of items returned.

Item[n].id

Identifier of the nth item within the list of returned items.

Item[n].drn

GroupWise specific identifier of the nth returned item.

Item[n].type

Type of the nth item: Appointment, Note, or Task.

Item[n].priority

Priority of the nth item.

Item[n].from

Sender of the nth item.

Item[n].toId

List of user identifiers to whom the nth item was sent.

Item[n].subject

Subject of the nth item.

Item[n].subType

Subtype of the nth item:

  • Item.SHARED_ADDRESS_BOOK
  • Item.PERSONAL
  • Item.SHARED_FOLDER
  • Item.DISCUSSION
  • Item.WORKFLOW
  • Item.REPLY_REQUESTED

Item[n].Folder.newName

Name given to a shared folder when it is being accepted.

Item[n].Status.read

Specifies read or unread.

Item[n].Status.accepted

Specifies accepted or unaccepted.

Item[n].Status.completed

Specifies completed or uncompleted.

Item[n].dateSent

Date the nth item was sent.

Item[n].dateStart

Start time for the nth item for calendar items.

Item[n].dateEnd

End time for the nth item for appointments, or due date for tasks.

Item[n].location

Location of the nth item for appointments.

Item[n].isOutbound

The nth item is a sent item.

Item[n].Priority.task

Priority of the nth item.

Item[n].dateTaskAssigned

Assigned date for the nth item for tasks.

Item[n].Library.id

Library ID of the nth item for document references.

Item[n].Document.id

Document ID of the nth item for document references.

Item[n].Document.version

Document version of the nth item for document references: Official, Current, or numeric version number.

Item[n].Document.ext

Document extension of the nth item for document references.

Item[n].hasAttachment

Specifies if the nth item has attachments.

Folder.hasInbound

1 specifies that the returned list of items contains received items.

Folder.hasOutbound

1 specifies that the returned list of items contains send items.

User.Access.HTMLDoc

1 enables viewing documents in HTML format (global).

User.Access.HTMLDocNative

1 enables viewing documents in native format (global).

Item[n].allowViewNative

1 enables native viewing for this document.

Item[n].allowView

1 enables HTML viewing for this document.

Example

/servlet/webacc?User.context=xyz&action=Folder.Open&Folder.id=2