FindItemType
extends BaseRequestType
in package
Defines a request to find items in a mailbox.
Table of Contents
Properties
- $CalendarView : CalendarViewType
- Provides time span limits to define a search for calendar items.
- $ContactsView : ContactsViewType
- Defines a search for contact items based on alphabetical display names.
- $DistinguishedGroupBy : DistinguishedGroupByType
- Provides standard groupings for FindItem queries.
- $FractionalPageItemView : FractionalPageViewType
- Describes where the paged view starts and the maximum number of items returned in a FindItem request.
- $GroupBy : GroupByType
- Specifies arbitrary groupings for FindItem queries.
- $IndexedPageItemView : IndexedPageViewType
- Describes how paged item information is returned for a FindItem request.
- $ItemShape : ItemResponseShapeType
- Identifies the item properties and content to include in a FindItem operation response.
- $ParentFolderIds : NonEmptyArrayOfBaseFolderIdsType
- Identifies folders to search for the FindItem and FindFolder operations.
- $QueryString : QueryStringType
- Contains a mailbox query string based on Advanced Query Syntax (AQS).
- $Restriction : RestrictionType
- Defines the restriction or query that is used to filter items or folders in FindItem/FindFolder and search folder operations.
- $SortOrder : NonEmptyArrayOfFieldOrdersType
- Defines how items are sorted in a FindItem request.
- $Traversal : string
- Defines whether the search finds items in folders or the folders' dumpsters.
Methods
- __clone() : mixed
- Clones any object properties on a type object when it is cloned. Allows for a deep clone required when using object to represent data types when making a SOAP call.
Properties
$CalendarView
Provides time span limits to define a search for calendar items.
public
CalendarViewType
$CalendarView
This element is optional.
Tags
$ContactsView
Defines a search for contact items based on alphabetical display names.
public
ContactsViewType
$ContactsView
This element is optional.
Tags
$DistinguishedGroupBy
Provides standard groupings for FindItem queries.
public
DistinguishedGroupByType
$DistinguishedGroupBy
This element is optional.
Tags
$FractionalPageItemView
Describes where the paged view starts and the maximum number of items returned in a FindItem request.
public
FractionalPageViewType
$FractionalPageItemView
The paged view offset from the beginning of the set of found items is described by a fraction.
This element is optional.
Tags
$GroupBy
Specifies arbitrary groupings for FindItem queries.
public
GroupByType
$GroupBy
This element is optional.
Tags
$IndexedPageItemView
Describes how paged item information is returned for a FindItem request.
public
IndexedPageViewType
$IndexedPageItemView
This element is optional.
Tags
$ItemShape
Identifies the item properties and content to include in a FindItem operation response.
public
ItemResponseShapeType
$ItemShape
Tags
$ParentFolderIds
Identifies folders to search for the FindItem and FindFolder operations.
public
NonEmptyArrayOfBaseFolderIdsType
$ParentFolderIds
Tags
$QueryString
Contains a mailbox query string based on Advanced Query Syntax (AQS).
public
QueryStringType
$QueryString
Tags
$Restriction
Defines the restriction or query that is used to filter items or folders in FindItem/FindFolder and search folder operations.
public
RestrictionType
$Restriction
This element is optional.
Tags
$SortOrder
Defines how items are sorted in a FindItem request.
public
NonEmptyArrayOfFieldOrdersType
$SortOrder
This element is optional.
Tags
$Traversal
Defines whether the search finds items in folders or the folders' dumpsters.
public
string
$Traversal
This attribute is required.
Tags
Methods
__clone()
Clones any object properties on a type object when it is cloned. Allows for a deep clone required when using object to represent data types when making a SOAP call.
public
__clone() : mixed