Hosted Email 2007::GetResourceMailbox

Article
06/17/2010

This procedure retrieves the attributes of a resource mailbox from Exchange.

Arguments

Input Arguments	Required	Type	Description
<preferredDomainController>	Yes	string	The domain controller to use for Active Directory actions.
<user>	Yes	string	The Lightweight Directory Access Protocol (LDAP) path of the user object for which the mailbox attributes will be retrieved.

Output Arguments	Type	Description
<alias>	string	The e-mail alias of the mailbox that you are querying. The alias can be a combination of characters separated by a period with no intervening spaces.
<database>	string	The unique path of the Exchange Database store.
<resourceType>	Enum	The type of the resource: Room or Equipment.
<emailAddresses>	complexType	The proxy addresses of the mailbox. The primary Simple Mail Transfer Protocol (SMTP) address is the first in the list of proxy addresses.
<emailAddresses>/<value >	string	SMTP proxy address.
<resourceCapacity>	nonNegativeInteger	The capacity of the resource.
<automateProcessing>	Enum	The automate calendar processing behaviors on the mailbox. None - Both resource booking and the Calendar Attendant will be disabled. AutoUpdate - The Calendar Attendant will process meeting requests and responses. AutoAccept - Both Calendar Attendant and resource booking will be enabled.
<allBookInPolicy>	boolean	Whether to automatically approve in-policy requests from all users.
<allRequestInPolicy>	boolean	Whether to allow all users to submit in-policy requests.
<allRequestOutOfPolicy>	boolean	Whether to allow all users to submit out-of-policy requests. Out-of-policy requests are subject to approval by a resource mailbox delegate.
<bookInPolicy>	complexType	A list of users who are allowed to submit in-policy meeting requests to the resource mailbox. Any in-policy meeting requests from these users will automatically be approved.
<bookInPolicy>/<recipientId>	string	The ID of a recipient in the list.
<forwardRequestsToDelegates>	boolean	Whether to forward incoming meeting requests to the delegates defined for the mailbox.
<requestInPolicy>	complexType	A list of users who are allowed to submit in-policy meeting requests to the resource mailbox. All in-policy meeting requests from these users will be subject to approval by a resource mailbox delegate.
<requestInPolicy>/<recipientId>	string	The ID of a recipient in the list.
<requestOutOfPolicy>	complexType	A list of users who are allowed to submit out-of-policy requests. Out-of-policy requests are subject to approval by a resource mailbox delegate.
<requestOutOfPolicy>/<recipientId>	string	The ID of a recipient in the list.
<resourceDelegates>	complexType	A list of users who are resource mailbox delegates. Resource mailbox delegates can approve or reject requests sent to this resource mailbox.
<resourceDelegates>/<recipientId>	string	The ID of a recipient in the list.
<tentativePendingApproval>	boolean	Whether to mark pending requests as tentative on the calendar. If set to False, pending requests are marked as free.
<allowConflicts>	boolean	Whether to allow conflicting meeting requests.
<allowRecurringMeetings>	boolean	Whether to allow recurring meetings.
<bookingWindowInDays>	nonNegativeInteger	The number of days meetings are allowed to be booked in advance.
<conflictPercentageAllowed>	nonNegativeInteger	A conflict percentage threshold for recurring meetings. If the percentage of instances of a recurring meeting that conflict with other meetings exceeds this number, the recurring meeting request will be declined.
<enforceSchedulingHorizon>	boolean	Whether recurring meetings that have an end date beyond the booking window will be rejected.
<maximumConflictInstances>	nonNegativeInteger	The maximum number of conflicts allowed for recurring meetings. If the number of instances for a recurring meeting that are in conflict exceeds this number, the recurring meeting request will be declined.
<maximumDurationInMinutes>	nonNegativeInteger	The maximum duration allowed for incoming meeting requests.
<processExternalMeetingMessages>	boolean	Whether to process meeting requests originating outside the Exchange organization.
<scheduleOnlyDuringWorkHours>	boolean	Whether to allow meetings to be scheduled outside work hours.
<addNewRequestsTentatively>	boolean	Whether to put new calendar items tentatively on the calendar. If the AddNewRequestsTentatively parameter is set to False, only existing calendar items are updated by the Calendar Attendant.
<addOrganizerToSubject>	boolean	Whether the meeting organizer's name will be used as the subject of the meeting request.
<defaultReminderTime>	nonNegativeInteger	The default reminder time for the meeting requests.
<deleteAttachments>	boolean	Whether to remove the attachments from all incoming requests and messages.
<deleteComments>	boolean	Whether to remove any text in the message body of incoming requests.
<deleteNonCalendarItems>	boolean	Whether to remove all non-calendar items received by the mailbox.
<deleteSubject>	boolean	Whether to remove the subject from all incoming requests and messages.
<disableReminders>	boolean	Whether to disable reminders for meetings in the mailbox.
<organizerInfo>	boolean	Whether to send organizer information when a meeting request is declined because of conflicts.
<removeForwardedMeetingNotifications>	boolean	Whether to move meeting forwarding notifications to the Deleted Items folder after they are processed by the Calendar Attendant.
<removeOldMeetingMessages>	boolean	Whether to remove old and redundant updates and responses.
<removePrivateProperty>	boolean	Whether to remove the "private" flag of incoming requests.
<addAdditionalResponse>	boolean	Whether additional information would be sent from the resource mailbox when responding to meeting requests.
<additionalResponse>	string	The additional information to be included in responses to meeting requests.
<enableResponseDetails>	boolean	Whether to include the reasons for accepting or declining a meeting in the response e-mail message.

Remarks

Security

Caller must be at least a member of role: Users.

Permission Check

No explicit permission check is required for this procedure. The procedure calls Managed Email 2007::GetResourceMailbox which performs a test for Users.

Preconditions

The Hosted Email 2007 namespace has been initialized.

Note

Retrieve of some basic mailbox attributes is not supported in this procedure to avoid redundancy. User can call the Hosted Email 2007::GetMailbox procedure to retrieve them.

Schema Definition

Input

<executeData> 
        <preferredDomainController>1..1</preferredDomainController> 
        <user>1..1</user> 
</executeData>

Output

<executeData> 
    <result>1..1 
        <alias>1..1</alias> 
        <database>1..1</database> 
        <resourceType>1..1</resourceType> 
        <emailAddresses> 
            1..1 
            <value>1..unbounded </value> 
        </emailAddresses> 
        <resourceCapacity>0..1</resourceCapacity> 
        <automateProcessing>0..1</automateProcessing> 
        <allBookInPolicy>0..1</allBookInPolicy> 
        <allRequestInPolicy>0..1</allRequestInPolicy> 
        <allRequestOutOfPolicy>0..1</allRequestOutOfPolicy> 
        <bookInPolicy> 
            0..1 
            <recipientId>0..unbound</recipientId> 
        </bookInPolicy> 
        <forwardRequestsToDelegates>0..1</forwardRequestsToDelegates> 
        <requestInPolicy> 
            0..1 
            <recipientId>0..unbound</recipientId> 
        </requestInPolicy> 
        <requestOutOfPolicy> 
            0..1 
            <recipientId>0..unbound</recipientId> 
        </requestOutOfPolicy> 
        <resourceDelegates> 
            0..1 
            <recipientId>0..unbound</recipientId> 
        </resourceDelegates> 
        <tentativePendingApproval>0..1</tentativePendingApproval> 
        <allowConflicts>0..1</allowConflicts> 
        <allowRecurringMeetings>0..1</allowRecurringMeetings> 
        <bookingWindowInDays>0..1</bookingWindowInDays> 
        <conflictPercentageAllowed>0..1</conflictPercentageAllowed> 
        <enforceSchedulingHorizon>0..1</enforceSchedulingHorizon> 
        <maximumConflictInstances>0..1</maximumConflictInstances> 
        <maximumDurationInMinutes>0..1</maximumDurationInMinutes> 
        <processExternalMeetingMessages>0..1</processExternalMeetingMessages> 
        <scheduleOnlyDuringWorkHours>0..1</scheduleOnlyDuringWorkHours> 
        <addNewRequestsTentatively>0..1</addNewRequestsTentatively> 
        <addOrganizerToSubject>0..1</addOrganizerToSubject> 
        <defaultReminderTime>0..1</defaultReminderTime> 
        <deleteAttachments>0..1</deleteAttachments> 
        <deleteComments>0..1</deleteComments> 
        <deleteNonCalendarItems>0..1</deleteNonCalendarItems> 
        <deleteSubject>0..1</deleteSubject> 
        <disableReminders>0..1</disableReminders> 
        <organizerInfo>0..1</organizerInfo> 
        <removeForwardedMeetingNotifications>0..1 </removeForwardedMeetingNotifications> 
        <removeOldMeetingMessages>0..1</removeOldMeetingMessages> 
        <removePrivateProperty>0..1</removePrivateProperty> 
        <addAdditionalResponse>0..1</addAdditionalResponse> 
        <additionalResponse>0..1</additionalResponse> 
        <enableResponseDetails>0..1</enableResponseDetails> 
    </result> 
</executeData>

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
    <!--Specifies the LDAP path of the user object to retrieve the mailbox for.--> 
    <user>LDAP://CN=Room101@AlpineSkiHouse.com,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</user> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Email 2007" procedure="GetResourceMailbox" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="user" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <result> 
      <!--The e-mail alias of the mailbox that you are retrieving.--> 
      <alias>room101</alias> 
      <!--The unique path of the Exchange Database store.--> 
      <database>EXMBXCLUS01\SG01\HostedMailstore01</database> 
      <!--Type of the resource, could be Room or Equipment.--> 
      <resourceType>Room</resourceType> 
      <!--Specifies the proxy addresses of the mailbox.  The primary Simple Mail Transfer Protocol (SMTP) address is the first in the list of proxy addresses.--> 
      <emailAddresses> 
        <!--SMTP proxy address.--> 
        <value>room101@alpineskihouse.com</value> 
      </emailAddresses> 
      <!--Capacity of the resource--> 
      <resourceCapacity>15</resourceCapacity> 
      <!--Specifies the automate calendar processing behaviors on the mailbox.--> 
      <automateProcessing>AutoAccept</automateProcessing> 
      <!--Specifies whether to automatically approve in-policy requests from all users.--> 
      <allBookInPolicy>true</allBookInPolicy> 
      <!--Specifies whether to allow all users to submit in-policy requests.--> 
      <allRequestInPolicy>true</allRequestInPolicy> 
      <!--Specifies whether to allow all users to submit out-of-policy requests.--> 
      <allRequestOutOfPolicy>true</allRequestOutOfPolicy> 
      <!--Specifies a list of users who are allowed to submit in-policy meeting requests to the resource mailbox.--> 
      <bookInPolicy> 
        <!--Specifies the ID of a recipient in the list.--> 
        <recipientId>johnc@alpineskihouse.com</recipientId> 
      </bookInPolicy> 
      <!----> 
      <forwardRequestsToDelegates>true</forwardRequestsToDelegates> 
      <!--Specifies a list of users who are allowed to submit in-policy meeting requests to the resource mailbox.--> 
      <requestInPolicy> 
        <!--Specifies the ID of a recipient in the list.--> 
        <recipientId>johnc@alpineskihouse.com</recipientId> 
      </requestInPolicy> 
      <!--Specifies a list of users who are allowed to submit out-of-policy requests.--> 
      <requestOutOfPolicy> 
        <!--Specifies the ID of a recipient in the list.--> 
        <recipientId>johnc@alpineskihouse.com</recipientId> 
      </requestOutOfPolicy> 
      <!--Specifies a list of users who are resource mailbox delegates. Resource mailbox delegates can approve or reject requests sent to this resource mailbox.--> 
      <resourceDelegates> 
        <!--Specifies the ID of a recipient in the list.--> 
        <recipientId>johnc@alpineskihouse.com</recipientId> 
      </resourceDelegates> 
      <!--Specifies whether to mark pending requests as tentative on the calendar. If set to False, pending requests are marked as free.--> 
      <tentativePendingApproval>true</tentativePendingApproval> 
      <!--Specifies whether to allow conflicting meeting requests.--> 
      <allowConflicts>true</allowConflicts> 
      <!--Specifies whether to allow recurring meetings.--> 
      <allowRecurringMeetings>true</allowRecurringMeetings> 
      <!--Specifies the number of days meetings are allowed to be booked in advance.--> 
      <bookingWindowInDays>180</bookingWindowInDays> 
      <!--Specifies a conflict percentage threshold for recurring meetings.--> 
      <conflictPercentageAllowed>0</conflictPercentageAllowed> 
      <!--Specifies whether recurring meetings that have an end date beyond the booking window will be rejected.--> 
      <enforceSchedulingHorizon>true</enforceSchedulingHorizon> 
      <!--Specifies the maximum number of conflicts allowed for recurring meetings. --> 
      <maximumConflictInstances>0</maximumConflictInstances> 
      <!--Specifies the maximum duration allowed for incoming meeting requests.--> 
      <maximumDurationInMinutes>1440</maximumDurationInMinutes> 
      <!--Specifies whether to process meeting requests originating outside the Exchange organization.--> 
      <processExternalMeetingMessages>true</processExternalMeetingMessages> 
      <!--Specifies whether to allow meetings to be scheduled outside work hours.--> 
      <scheduleOnlyDuringWorkHours>true</scheduleOnlyDuringWorkHours> 
      <!--Specifies whether to put new calendar items tentatively on the calendar. --> 
      <addNewRequestsTentatively>true</addNewRequestsTentatively> 
      <!--Specifies whether the meeting organizer's name will be used as the subject of the meeting request.--> 
      <addOrganizerToSubject>true</addOrganizerToSubject> 
      <!--Specifies the default reminder time for the meeting requests.--> 
      <defaultReminderTime>5</defaultReminderTime> 
      <!--Specifies whether to remove the attachments from all incoming requests and messages.--> 
      <deleteAttachments>true</deleteAttachments> 
      <!--Specifies whether to remove any text in the message body of incoming requests.--> 
      <deleteComments>true</deleteComments> 
      <!--Specifies whether to remove all non-calendar items received by the mailbox.--> 
      <deleteNonCalendarItems>true</deleteNonCalendarItems> 
      <!--Specifies whether to remove the subject from all incoming requests and messages.--> 
      <deleteSubject>true</deleteSubject> 
      <!--Specifies if you want to disable reminders for meetings in the mailbox.--> 
      <disableReminders>true</disableReminders> 
      <!--Specifies whether to send organizer information when a meeting request is declined because of conflicts.--> 
      <organizerInfo>true</organizerInfo> 
      <!--Specifies whether to move meeting forwarding notifications to the Deleted Items folder after they are processed by the Calendar Attendant.--> 
      <removeForwardedMeetingNotifications>true</removeForwardedMeetingNotifications> 
      <!--Specifies whether to remove old and redundant updates and responses.--> 
      <removeOldMeetingMessages>true</removeOldMeetingMessages> 
      <!--Specifies whether to remove the "private" flag of incoming requests.--> 
      <removePrivateProperty>true</removePrivateProperty> 
      <!--Specifies whether additional information would be sent from the resource mailbox when responding to meeting requests.--> 
      <addAdditionalResponse>true</addAdditionalResponse> 
      <!--Specifies the additional information to be included in responses to meeting requests.--> 
      <additionalResponse>Room location: Southwest in the second floor of the AlpineSki building.</additionalResponse> 
      <!--Specifies whether to include the reasons for accepting or declining a meeting in the response e-mail message.--> 
      <enableResponseDetails>true</enableResponseDetails> 
    </result> 
  </data> 
</response>

Applies To

Hosted Email 2007 Namespace for:

Hosted Messaging and Collaboration version 4.5
Hosted Messaging and Collaboration version 4.0

Hosted Email 2007::GetResourceMailbox

Arguments

Remarks

Schema Definition

Sample Code

Applies To

See also

Tasks

Additional resources