Table of Contents

Class Conversation

Namespace
Microsoft.Exchange.WebServices.Data
Assembly
Microsoft.Exchange.WebServices.dll

Represents a collection of Conversation related properties. Properties available on this object are defined in the ConversationSchema class.

public class Conversation : ServiceObject
Inheritance
Conversation
Inherited Members

Properties

Categories

Gets a list summarizing the categories stamped on messages in this conversation, in the current folder only.

public StringList Categories { get; }

Property Value

StringList

DraftItemIds

Gets the draft item ids.

public ItemIdCollection DraftItemIds { get; }

Property Value

ItemIdCollection

FlagStatus

Gets the flag status for this conversation, calculated by aggregating individual messages flag status in the current folder.

public ConversationFlagStatus FlagStatus { get; }

Property Value

ConversationFlagStatus

GlobalCategories

Gets a list summarizing the categories stamped on messages in this conversation, across all folders in the mailbox.

public StringList GlobalCategories { get; }

Property Value

StringList

GlobalFlagStatus

Gets the flag status for this conversation, calculated by aggregating individual messages flag status across all folders in the mailbox.

public ConversationFlagStatus GlobalFlagStatus { get; }

Property Value

ConversationFlagStatus

GlobalHasAttachments

Gets a value indicating if at least one message in this conversation, across all folders in the mailbox, has an attachment.

public bool GlobalHasAttachments { get; }

Property Value

bool

GlobalHasIrm

Gets a value indicating if at least one message in this conversation, across all folders in the mailbox, is an IRM.

public bool GlobalHasIrm { get; }

Property Value

bool

GlobalIconIndex

Gets the conversation global IconIndex.

public IconIndex GlobalIconIndex { get; }

Property Value

IconIndex

GlobalImportance

Gets the importance of this conversation, calculated by aggregating individual messages importance across all folders in the mailbox.

public Importance GlobalImportance { get; }

Property Value

Importance

GlobalItemClasses

Gets a list summarizing the classes of the items in this conversation, across all folders in the mailbox.

public StringList GlobalItemClasses { get; }

Property Value

StringList

GlobalItemIds

Gets the Ids of the messages in this conversation, across all folders in the mailbox.

public ItemIdCollection GlobalItemIds { get; }

Property Value

ItemIdCollection

GlobalLastDeliveryTime

Gets the delivery time of the message that was last received in this conversation across all folders in the mailbox.

public DateTime GlobalLastDeliveryTime { get; }

Property Value

DateTime

GlobalMessageCount

Gets the total number of messages in this conversation across all folders in the mailbox.

public int GlobalMessageCount { get; }

Property Value

int

GlobalSize

Gets the size of this conversation, calculated by adding the sizes of all messages in the conversation across all folders in the mailbox.

public int GlobalSize { get; }

Property Value

int

GlobalUniqueRecipients

Gets a list of all the people who have received messages in this conversation across all folders in the mailbox.

public StringList GlobalUniqueRecipients { get; }

Property Value

StringList

GlobalUniqueSenders

Gets a list of all the people who have sent messages in this conversation across all folders in the mailbox.

public StringList GlobalUniqueSenders { get; }

Property Value

StringList

GlobalUniqueUnreadSenders

Gets a list of all the people who have sent messages that are currently unread in this conversation across all folders in the mailbox.

public StringList GlobalUniqueUnreadSenders { get; }

Property Value

StringList

GlobalUnreadCount

Gets the total number of unread messages in this conversation across all folders in the mailbox.

public int GlobalUnreadCount { get; }

Property Value

int

HasAttachments

Gets a value indicating if at least one message in this conversation, in the current folder only, has an attachment.

public bool HasAttachments { get; }

Property Value

bool

HasIrm

Gets a value indicating if at least one message in this conversation, in the current folder only, is an IRM.

public bool HasIrm { get; }

Property Value

bool

IconIndex

Gets the conversation IconIndex.

public IconIndex IconIndex { get; }

Property Value

IconIndex

Id

Gets the Id of this Conversation.

public ConversationId Id { get; }

Property Value

ConversationId

Importance

Gets the importance of this conversation, calculated by aggregating individual messages importance in the current folder only.

public Importance Importance { get; }

Property Value

Importance

InstanceKey

Gets the conversation instance key.

public byte[] InstanceKey { get; }

Property Value

byte[]

ItemClasses

Gets a list summarizing the classes of the items in this conversation, in the current folder only.

public StringList ItemClasses { get; }

Property Value

StringList

ItemIds

Gets the Ids of the messages in this conversation, in the current folder only.

public ItemIdCollection ItemIds { get; }

Property Value

ItemIdCollection

LastDeliveryTime

Gets the delivery time of the message that was last received in this conversation in the current folder only.

public DateTime LastDeliveryTime { get; }

Property Value

DateTime

LastModifiedTime

Gets the date and time this conversation was last modified.

public DateTime LastModifiedTime { get; }

Property Value

DateTime

MessageCount

Gets the total number of messages in this conversation in the current folder only.

public int MessageCount { get; }

Property Value

int

Preview

Gets the conversation Preview.

public string Preview { get; }

Property Value

string

Size

Gets the size of this conversation, calculated by adding the sizes of all messages in the conversation in the current folder only.

public int Size { get; }

Property Value

int

Topic

Gets the topic of this Conversation.

public string Topic { get; }

Property Value

string

UniqueRecipients

Gets a list of all the people who have received messages in this conversation in the current folder only.

public StringList UniqueRecipients { get; }

Property Value

StringList

UniqueSenders

Gets a list of all the people who have sent messages in this conversation in the current folder only.

public StringList UniqueSenders { get; }

Property Value

StringList

UniqueUnreadSenders

Gets a list of all the people who have sent messages that are currently unread in this conversation in the current folder only.

public StringList UniqueUnreadSenders { get; }

Property Value

StringList

UnreadCount

Gets the total number of unread messages in this conversation in the current folder only.

public int UnreadCount { get; }

Property Value

int

Methods

ClearItemFlags(FolderId)

Clear flags for conversation items. Calling this method results in a call to EWS.

public void ClearItemFlags(FolderId contextFolderId)

Parameters

contextFolderId FolderId

The Id of the folder items must belong to in order to be unflagged. If contextFolderId is null, flags for items in conversation across the entire mailbox are cleared.

CopyItemsInConversation(FolderId, FolderId)

Copies items in the specified conversation to a specific folder. Calling this method results in a call to EWS.

public void CopyItemsInConversation(FolderId contextFolderId, FolderId destinationFolderId)

Parameters

contextFolderId FolderId

The Id of the folder items must belong to in order to be copied. If contextFolderId is null, items across the entire mailbox are copied.

destinationFolderId FolderId

The Id of the destination folder.

DeleteItems(FolderId, DeleteMode)

Deletes items in the specified conversation. Calling this method results in a call to EWS.

public void DeleteItems(FolderId contextFolderId, DeleteMode deleteMode)

Parameters

contextFolderId FolderId

The Id of the folder items must belong to in order to be deleted. If contextFolderId is null, items across the entire mailbox are deleted.

deleteMode DeleteMode

The deletion mode.

DisableAlwaysCategorizeItems(bool)

Sets up a conversation so that any item received within that conversation is no longer categorized. Calling this method results in a call to EWS.

public void DisableAlwaysCategorizeItems(bool processSynchronously)

Parameters

processSynchronously bool

Indicates whether the method should return only once disabling this rule and removing the categories from existing items in the conversation is completely done. If processSynchronously is false, the method returns immediately.

DisableAlwaysDeleteItems(bool)

Sets up a conversation so that any item received within that conversation is no longer moved to Deleted Items folder. Calling this method results in a call to EWS.

public void DisableAlwaysDeleteItems(bool processSynchronously)

Parameters

processSynchronously bool

Indicates whether the method should return only once disabling this rule and restoring the items in the conversation is completely done. If processSynchronously is false, the method returns immediately.

DisableAlwaysMoveItemsInConversation(bool)

Sets up a conversation so that any item received within that conversation is no longer moved to a specific folder. Calling this method results in a call to EWS.

public void DisableAlwaysMoveItemsInConversation(bool processSynchronously)

Parameters

processSynchronously bool

Indicates whether the method should return only once disabling this rule is completely done. If processSynchronously is false, the method returns immediately.

EnableAlwaysCategorizeItems(IEnumerable<string>, bool)

Sets up a conversation so that any item received within that conversation is always categorized. Calling this method results in a call to EWS.

public void EnableAlwaysCategorizeItems(IEnumerable<string> categories, bool processSynchronously)

Parameters

categories IEnumerable<string>

The categories that should be stamped on items in the conversation.

processSynchronously bool

Indicates whether the method should return only once enabling this rule and stamping existing items in the conversation is completely done. If processSynchronously is false, the method returns immediately.

EnableAlwaysDeleteItems(bool)

Sets up a conversation so that any item received within that conversation is always moved to Deleted Items folder. Calling this method results in a call to EWS.

public void EnableAlwaysDeleteItems(bool processSynchronously)

Parameters

processSynchronously bool

Indicates whether the method should return only once enabling this rule and deleting existing items in the conversation is completely done. If processSynchronously is false, the method returns immediately.

EnableAlwaysMoveItems(FolderId, bool)

Sets up a conversation so that any item received within that conversation is always moved to a specific folder. Calling this method results in a call to EWS.

public void EnableAlwaysMoveItems(FolderId destinationFolderId, bool processSynchronously)

Parameters

destinationFolderId FolderId

The Id of the folder to which conversation items should be moved.

processSynchronously bool

Indicates whether the method should return only once enabling this rule and moving existing items in the conversation is completely done. If processSynchronously is false, the method returns immediately.

FlagItems(FolderId, DateTime?, DateTime?)

Flags conversation items. Calling this method results in a call to EWS.

public void FlagItems(FolderId contextFolderId, DateTime? startDate, DateTime? dueDate)

Parameters

contextFolderId FolderId

The Id of the folder items must belong to in order to be flagged. If contextFolderId is null, items in conversation across the entire mailbox are flagged.

startDate DateTime?

The start date (can be null).

dueDate DateTime?

The due date (can be null).

FlagItemsComplete(FolderId, DateTime?)

Flag conversation items as complete. Calling this method results in a call to EWS.

public void FlagItemsComplete(FolderId contextFolderId, DateTime? completeDate)

Parameters

contextFolderId FolderId

The Id of the folder items must belong to in order to be flagged as complete. If contextFolderId is null, items in conversation across the entire mailbox are marked as complete.

completeDate DateTime?

The complete date (can be null).

MoveItemsInConversation(FolderId, FolderId)

Moves items in the specified conversation to a specific folder. Calling this method results in a call to EWS.

public void MoveItemsInConversation(FolderId contextFolderId, FolderId destinationFolderId)

Parameters

contextFolderId FolderId

The Id of the folder items must belong to in order to be moved. If contextFolderId is null, items across the entire mailbox are moved.

destinationFolderId FolderId

The Id of the destination folder.

SetReadStateForItemsInConversation(FolderId, bool)

Sets the read state of items in the specified conversation. Calling this method results in a call to EWS.

public void SetReadStateForItemsInConversation(FolderId contextFolderId, bool isRead)

Parameters

contextFolderId FolderId

The Id of the folder items must belong to in order for their read state to be set. If contextFolderId is null, the read states of items across the entire mailbox are set.

isRead bool

if set to true, conversation items are marked as read; otherwise they are marked as unread.

SetReadStateForItemsInConversation(FolderId, bool, bool)

Sets the read state of items in the specified conversation. Calling this method results in a call to EWS.

public void SetReadStateForItemsInConversation(FolderId contextFolderId, bool isRead, bool suppressReadReceipts)

Parameters

contextFolderId FolderId

The Id of the folder items must belong to in order for their read state to be set. If contextFolderId is null, the read states of items across the entire mailbox are set.

isRead bool

if set to true, conversation items are marked as read; otherwise they are marked as unread.

suppressReadReceipts bool

if set to true read receipts are suppressed.

SetRetentionPolicyForItemsInConversation(FolderId, RetentionType, Guid?)

Sets the retention policy of items in the specified conversation. Calling this method results in a call to EWS.

public void SetRetentionPolicyForItemsInConversation(FolderId contextFolderId, RetentionType retentionPolicyType, Guid? retentionPolicyTagId)

Parameters

contextFolderId FolderId

The Id of the folder items must belong to in order for their retention policy to be set. If contextFolderId is null, the retention policy of items across the entire mailbox are set.

retentionPolicyType RetentionType

Retention policy type.

retentionPolicyTagId Guid?

Retention policy tag id. Null will clear the policy.