RetrieveMailboxTrackingFoldersRequest Class

Article
10/20/2016

Applies To: Dynamics CRM 2015

Contains the data needed to retrieve folder-level tracking rules for a mailbox.

Namespace: Microsoft.Crm.Sdk.Messages
Assembly: Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Crm.Sdk.Messages.RetrieveMailboxTrackingFoldersRequest

Syntax

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveMailboxTrackingFoldersRequest : OrganizationRequest

[DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")]
public ref class RetrieveMailboxTrackingFoldersRequest sealed : OrganizationRequest

[<Sealed>]
[<DataContractAttribute(Namespace = "https://schemas.microsoft.com/crm/2011/Contracts")>]
type RetrieveMailboxTrackingFoldersRequest = 
    class
        inherit OrganizationRequest
    end

<DataContractAttribute(Namespace := "https://schemas.microsoft.com/crm/2011/Contracts")>
Public NotInheritable Class RetrieveMailboxTrackingFoldersRequest
    Inherits OrganizationRequest

Constructors

	Name	Description
	RetrieveMailboxTrackingFoldersRequest()	Initializes a new instance of the RetrieveMailboxTrackingFoldersRequest class.

Properties

	Name	Description
	ExtensionData	Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)
	Item[String]	Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)
	MailboxId	Gets or sets the mailbox ID of the user for which you want to retrieve the folder-level tracking rules.
	Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)
	RequestId	Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)
	RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the RetrieveMailboxTrackingFoldersResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges on the Mailbox and MailboxTrackingFolder entities, and access rights on the specified record in the MailboxId property.

Examples

The following example shows how to use this message to retrieve folder-level tracking rules for a mailbox. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface.

// Retrieve the folder mapping rules for a Mailbox
RetrieveMailboxTrackingFoldersRequest req = new RetrieveMailboxTrackingFoldersRequest
{
    MailboxId = _mailboxId.ToString()
};

RetrieveMailboxTrackingFoldersResponse resp = (RetrieveMailboxTrackingFoldersResponse)
                            _serviceProxy.Execute(req);
Console.WriteLine("Retrieved folder-level tracking rules for {0}:", _mailboxName);
int n = 1;
foreach (var folderMapping in resp.MailboxTrackingFolderMappings)
{
    Console.WriteLine("\tRule {0}: '{1}' is mapped to '{2}'.", 
        n, folderMapping.ExchangeFolderName, folderMapping.RegardingObjectName);
    n++;
}

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.