2.2.3.184.3 Total (Search)

The Total element is an optional child element of the Store element in Search command responses that provides an estimate of the total number of mailbox entries that matched the search Query element (section 2.2.3.142.2) value.

All elements referenced in this section are defined in the Search namespace.

Command request/response

Parent elements

Child elements

Data type

Number allowed

Search command response (section 2.2.1.16)

Store (section 2.2.3.178.3)

None

integer ([MS-ASDTYPE] section 2.6)

0...1 (optional)

The value of the Total element does not always equal the number of entries that are returned. To determine the number of entries that are returned by the Search command, use the Range element (section 2.2.3.143.3) value.

The Total element indicates the number of entries that are available. In cases where all the results are returned in the response XML, the value of the Total element is one more than the end-index value that is provided in the Range element. For example, if the Search command returns 15 entries, the value of the Range element is 0–14, while the value of the Total element is 15.

The Total element is used by clients to determine whether more matching entries were found in the mailbox than have been returned by the Search command. For example, a client might perform an initial search and specify a requested Range of 0–4 (return 5 entries maximum). If the Total element indicates that there are actually 25 matching items, the client can then enable the user to retrieve the full results.

Protocol Versions

The following table specifies the protocol versions that support this element. The client indicates the protocol version being used by setting either the MS-ASProtocolVersion header, as specified in [MS-ASHTTP] section 2.2.1.1.2.6, or the Protocol version field, as specified in [MS-ASHTTP] section 2.2.1.1.1.1, in the request.

Protocol version

Element support

2.5

Yes

12.0

Yes

12.1

Yes

14.0

Yes

14.1

Yes

16.0

Yes

16.1

Yes

Show: