Share via


RetrieveMailboxTrackingFoldersRequest Class

Definition

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

public ref class RetrieveMailboxTrackingFoldersRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class RetrieveMailboxTrackingFoldersRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type RetrieveMailboxTrackingFoldersRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveMailboxTrackingFoldersRequest
Inherits OrganizationRequest
Inheritance
RetrieveMailboxTrackingFoldersRequest
Attributes

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 instance.

// 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++;
}

Remarks

For the Web API use the RetrieveMailboxTrackingFolders function.

Usage

Pass an instance of this class to the Execute(OrganizationRequest) 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.

Constructors

RetrieveMailboxTrackingFoldersRequest()

Initializes a new instance of the RetrieveMailboxTrackingFoldersRequest class.

Properties

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 the request. Optional.

(Inherited from OrganizationRequest)
RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to