Documentation

TaskType extends ItemType
in package

Represents a task in the Exchange store.

Table of Contents

Properties

$ActualWork  : int
Represents the actual amount of time that is spent on a task.
$AssignedTime  : string
Represents the time when a task is assigned to a contact.
$Attachments  : NonEmptyArrayOfAttachmentsType
Contains the items or files that are attached to an item in the Exchange store.
$BillingInformation  : string
Holds billing information for a task.
$Body  : BodyType
Represents the actual body content of a message.
$Categories  : ArrayOfStringsType
Represents a collection of strings that identify the categories to which an item in the mailbox belongs.
$ChangeCount  : int
Specifies the version of the task.
$Companies  : ArrayOfStringsType
Represents the collection of companies that are associated with a contact or task.
$CompleteDate  : string
Represents the date on which a task is completed.
$Contacts  : ArrayOfStringsType
Contains a list of contacts that are associated with a task.
$ConversationId  : ItemIdType
Contains the identifier of an item or conversation.
$Culture  : string
Represents the culture for a given item in a mailbox.
$DateTimeCreated  : string
Represents the date and time that a given item in the mailbox was created.
$DateTimeReceived  : string
Represents the date and time that an item in a mailbox was received.
$DateTimeSent  : string
Represents the date and time that an item in a mailbox was sent.
$DelegationState  : string
Represents the status of a delegated task.
$Delegator  : string
Contains the name of the delegator who assigned the task.
$DisplayCc  : string
Represents the display string that is used for the contents of the Cc line.
$DisplayTo  : string
Represents the display string that is used for the contents of the To line.
$DueDate  : string
Represents the date when a task item is due.
$EffectiveRights  : EffectiveRightsType
Contains the client's rights based on the permission settings for the item or folder.
$ExtendedProperty  : array<string|int, ExtendedPropertyType>
Identifies extended properties on folders and items.
$HasAttachments  : bool
Represents a property that is set to true if an item has at least one visible attachment.
$Importance  : string
Describes the importance of an item.
$InReplyTo  : string
Represents the identifier of the item to which this item is a reply.
$InternetMessageHeaders  : NonEmptyArrayOfInternetHeadersType
Represents the collection of all Internet message headers that are contained in an item in a mailbox.
$IsAssignmentEditable  : int
Indicates whether the task is editable or not.
$IsAssociated  : bool
Indicates whether the item is associated with a folder.
$IsComplete  : bool
Indicates whether the task has been completed or not.
$IsDraft  : bool
Indicates whether an item has not yet been sent.
$IsFromMe  : bool
Indicates whether a user sent an item to him or herself.
$IsRecurring  : bool
Indicates whether a task is part of a recurring item.
$IsResend  : bool
Indicates whether the item had previously been sent.
$IsSubmitted  : bool
Indicates whether an item has been submitted to the Outbox default folder.
$IsTeamTask  : bool
Indicates whether the task is owned by a team or not.
$IsUnmodified  : bool
Indicates whether the item has been modified.
$ItemClass  : string
Represents the message class of an item.
$ItemId  : ItemIdType
Contains the unique identifier and change key of an item in the Exchange store.
$LastModifiedName  : string
Contains the display name of the last user to modify an item.
$LastModifiedTime  : string
Indicates when an item was last modified.
$Mileage  : string
Represents mileage for a task item.
$MimeContent  : MimeContentType
Contains the native Multipurpose Internet Mail Extensions (MIME) stream of an object that is represented in base64Binary format.
$Owner  : string
Represents the owner of a task.
$ParentFolderId  : FolderIdType
Represents the identifier of the parent folder that contains the item or folder.
$PercentComplete  : float
Describes the completion status of a task.
$ReceivedBy  : SingleRecipientType
Identifies the delegate in a delegate access scenario.
$ReceivedRepresenting  : SingleRecipientType
Identifies the principal in a delegate access scenario.
$Recurrence  : RecurrenceType
Contains recurrence information for recurring tasks.
$ReminderDueBy  : string
Represents the date and time when the event occurs.
$ReminderIsSet  : bool
Indicates whether a reminder has been set for an item in the Exchange store.
$ReminderMinutesBeforeStart  : int
Represents the number of minutes before an event when a reminder is displayed.
$ResponseObjects  : NonEmptyArrayOfResponseObjectsType
Contains a collection of all the response objects that are associated with an item in the Exchange store.
$Sensitivity  : string
Indicates the sensitivity level of an item.
$Size  : int
Represents the size in bytes of an item.
$StartDate  : string
Represents the start date of a task item.
$Status  : string
Represents the status of a task item.
$StatusDescription  : string
Contains an explanation of the task status.
$StoreEntryId  : string
Exchange store identifier of an item.
$Subject  : string
Represents the subject for Exchange store items and response objects.
$TotalWork  : int
Contains a description of how much work is associated with an item.
$UniqueBody  : BodyType
Represents an HTML fragment or plain text which represents the unique body of this conversation.
$WebClientEditFormQueryString  : string
Represents a URL to concatenate to the Microsoft Office Outlook Web App endpoint to edit an item in Outlook Web App.
$WebClientReadFormQueryString  : string
Represents a URL to concatenate to the Microsoft Office Outlook Web App endpoint to read an item in Outlook Web App.

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

$ActualWork

Represents the actual amount of time that is spent on a task.

public int $ActualWork
Tags
since

Exchange 2007

$AssignedTime

Represents the time when a task is assigned to a contact.

public string $AssignedTime
Tags
since

Exchange 2007

todo

Make a DateTime object.

$Attachments

Contains the items or files that are attached to an item in the Exchange store.

public NonEmptyArrayOfAttachmentsType $Attachments

This property is read-only.

Tags
since

Exchange 2007

$BillingInformation

Holds billing information for a task.

public string $BillingInformation
Tags
since

Exchange 2007

$Body

Represents the actual body content of a message.

public BodyType $Body
Tags
since

Exchange 2007

$Categories

Represents a collection of strings that identify the categories to which an item in the mailbox belongs.

public ArrayOfStringsType $Categories
Tags
since

Exchange 2007

$ChangeCount

Specifies the version of the task.

public int $ChangeCount
Tags
since

Exchange 2007

$Companies

Represents the collection of companies that are associated with a contact or task.

public ArrayOfStringsType $Companies
Tags
since

Exchange 2007

$CompleteDate

Represents the date on which a task is completed.

public string $CompleteDate
Tags
since

Exchange 2007

todo

Make a DateTime object.

$Contacts

Contains a list of contacts that are associated with a task.

public ArrayOfStringsType $Contacts
Tags
since

Exchange 2007

$ConversationId

Contains the identifier of an item or conversation.

public ItemIdType $ConversationId
Tags
since

Exchange 2010

$Culture

Represents the culture for a given item in a mailbox.

public string $Culture

Specified by using the RFC 1766 culture identifier; for example, en-US.

Tags
since

Exchange 2007

$DateTimeCreated

Represents the date and time that a given item in the mailbox was created.

public string $DateTimeCreated
Tags
since

Exchange 2007

todo

Make a DateTime object.

$DateTimeReceived

Represents the date and time that an item in a mailbox was received.

public string $DateTimeReceived
Tags
since

Exchange 2007

todo

Make a DateTime object.

$DateTimeSent

Represents the date and time that an item in a mailbox was sent.

public string $DateTimeSent
Tags
since

Exchange 2007

todo

Make a DateTime object.

$DelegationState

Represents the status of a delegated task.

public string $DelegationState

This is a read-only property.

Tags
since

Exchange 2007

see
TaskDelegateStateType

$Delegator

Contains the name of the delegator who assigned the task.

public string $Delegator
Tags
since

Exchange 2007

$DisplayCc

Represents the display string that is used for the contents of the Cc line.

public string $DisplayCc

This is the concatenated string of all Cc recipient display names.

Tags
since

Exchange 2007

$DisplayTo

Represents the display string that is used for the contents of the To line.

public string $DisplayTo

This is the concatenated string of all To recipient display names.

Tags
since

Exchange 2007

$DueDate

Represents the date when a task item is due.

public string $DueDate
Tags
since

Exchange 2007

todo

Make a DateTime object.

$EffectiveRights

Contains the client's rights based on the permission settings for the item or folder.

public EffectiveRightsType $EffectiveRights

This property is read-only.

Tags
since

Exchange 2007 SP1

$ExtendedProperty

Identifies extended properties on folders and items.

public array<string|int, ExtendedPropertyType> $ExtendedProperty = array()
Tags
since

Exchange 2007

$HasAttachments

Represents a property that is set to true if an item has at least one visible attachment.

public bool $HasAttachments

This property is read-only.

Tags
since

Exchange 2007

$Importance

Describes the importance of an item.

public string $Importance
Tags
since

Exchange 2007

see
ImportanceChoicesType

$InReplyTo

Represents the identifier of the item to which this item is a reply.

public string $InReplyTo
Tags
since

Exchange 2007

$InternetMessageHeaders

Represents the collection of all Internet message headers that are contained in an item in a mailbox.

public NonEmptyArrayOfInternetHeadersType $InternetMessageHeaders
Tags
since

Exchange 2007

$IsAssignmentEditable

Indicates whether the task is editable or not.

public int $IsAssignmentEditable

The following values are possible:

  • 0: The default for all task items.
  • 1: A task request.
  • 2: A task acceptance from a recipient of a task request.
  • 3: A task declination from a recipient of a task request.
  • 4: An update to a previous task request.
  • 5: Not used.

This element is read-only.

Tags
since

Exchange 2007

$IsAssociated

Indicates whether the item is associated with a folder.

public bool $IsAssociated
Tags
since

Exchange 2010

$IsComplete

Indicates whether the task has been completed or not.

public bool $IsComplete
Tags
since

Exchange 2007

$IsDraft

Indicates whether an item has not yet been sent.

public bool $IsDraft
Tags
since

Exchange 2007

$IsFromMe

Indicates whether a user sent an item to him or herself.

public bool $IsFromMe
Tags
since

Exchange 2007

$IsRecurring

Indicates whether a task is part of a recurring item.

public bool $IsRecurring

This element is read-only.

Tags
since

Exchange 2007

$IsResend

Indicates whether the item had previously been sent.

public bool $IsResend
Tags
since

Exchange 2007

$IsSubmitted

Indicates whether an item has been submitted to the Outbox default folder.

public bool $IsSubmitted
Tags
since

Exchange 2007

$IsTeamTask

Indicates whether the task is owned by a team or not.

public bool $IsTeamTask
Tags
since

Exchange 2007

$IsUnmodified

Indicates whether the item has been modified.

public bool $IsUnmodified
Tags
since

Exchange 2007

$ItemClass

Represents the message class of an item.

public string $ItemClass
Tags
since

Exchange 2007

see
ItemClassType

$ItemId

Contains the unique identifier and change key of an item in the Exchange store.

public ItemIdType $ItemId
Tags
since

Exchange 2007

$LastModifiedName

Contains the display name of the last user to modify an item.

public string $LastModifiedName
Tags
since

Exchange 2010

$LastModifiedTime

Indicates when an item was last modified.

public string $LastModifiedTime
Tags
since

Exchange 2010

todo

Make a DateTime object.

$Mileage

Represents mileage for a task item.

public string $Mileage
Tags
since

Exchange 2007

$MimeContent

Contains the native Multipurpose Internet Mail Extensions (MIME) stream of an object that is represented in base64Binary format.

public MimeContentType $MimeContent
Tags
since

Exchange 2007

$Owner

Represents the owner of a task.

public string $Owner

This is a read-only property.

Tags
since

Exchange 2007

$ParentFolderId

Represents the identifier of the parent folder that contains the item or folder.

public FolderIdType $ParentFolderId
Tags
since

Exchange 2007

$PercentComplete

Describes the completion status of a task.

public float $PercentComplete
Tags
since

Exchange 2007

$ReceivedBy

Identifies the delegate in a delegate access scenario.

public SingleRecipientType $ReceivedBy
Tags
since

Exchange 2007 SP1

deprecated

Exchange 2010

$ReceivedRepresenting

Identifies the principal in a delegate access scenario.

public SingleRecipientType $ReceivedRepresenting
Tags
since

Exchange 2007 SP1

deprecated

Exchange 2010

$Recurrence

Contains recurrence information for recurring tasks.

public RecurrenceType $Recurrence
Tags
since

Exchange 2007

$ReminderDueBy

Represents the date and time when the event occurs.

public string $ReminderDueBy

This is used by the ReminderMinutesBeforeStart element to determine when the reminder is displayed.

Tags
since

Exchange 2007

todo

Make a DateTime object.

$ReminderIsSet

Indicates whether a reminder has been set for an item in the Exchange store.

public bool $ReminderIsSet
Tags
since

Exchange 2007

$ReminderMinutesBeforeStart

Represents the number of minutes before an event when a reminder is displayed.

public int $ReminderMinutesBeforeStart
Tags
since

Exchange 2007

todo

Determine if we need a ReminderMinutesBeforeStartType implementation.

$ResponseObjects

Contains a collection of all the response objects that are associated with an item in the Exchange store.

public NonEmptyArrayOfResponseObjectsType $ResponseObjects
Tags
since

Exchange 2007

$Sensitivity

Indicates the sensitivity level of an item.

public string $Sensitivity
Tags
since

Exchange 2007

see
SensitivityChoicesType

$Size

Represents the size in bytes of an item.

public int $Size

This property is read-only.

Tags
since

Exchange 2007

$StartDate

Represents the start date of a task item.

public string $StartDate
Tags
since

Exchange 2007

todo

Make a DateTime object.

$Status

Represents the status of a task item.

public string $Status
Tags
since

Exchange 2007

see
TaskStatusType

$StatusDescription

Contains an explanation of the task status.

public string $StatusDescription

This is a read-only property.

Tags
since

Exchange 2007

$StoreEntryId

Exchange store identifier of an item.

public string $StoreEntryId
Tags
since

Exchange 2010 SP2

todo

Create a base64 class?

$Subject

Represents the subject for Exchange store items and response objects.

public string $Subject
Tags
since

Exchange 2007

$TotalWork

Contains a description of how much work is associated with an item.

public int $TotalWork
Tags
since

Exchange 2007

$UniqueBody

Represents an HTML fragment or plain text which represents the unique body of this conversation.

public BodyType $UniqueBody
Tags
since

Exchange 2010

$WebClientEditFormQueryString

Represents a URL to concatenate to the Microsoft Office Outlook Web App endpoint to edit an item in Outlook Web App.

public string $WebClientEditFormQueryString
Tags
since

Exchange 2010

$WebClientReadFormQueryString

Represents a URL to concatenate to the Microsoft Office Outlook Web App endpoint to read an item in Outlook Web App.

public string $WebClientReadFormQueryString
Tags
since

Exchange 2010

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

        
On this page

Search results