Hosted Email 2007::GetMailbox

This procedure retrieves user mailbox attributes.

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

Output Arguments	Description
<result>	The result node will contain a filtered list of the combination of the properties returned by the Microsoft Exchange 2007 Cmdlets Get-Mailbox and Get-CASMailbox. For more details on the properties returned in the results node, see theExchange 2007 SDK.
<result/ alias>	The e-mail alias of the mailbox that you are retrieving.
<result/ emailAddresses>	This parameter specifies all the proxy addresses of the mailbox. The primary Simple Mail Transfer Protocol (SMTP) address is the first in the list of proxy addresses.
<result/ emailAddresses/ value>	One or more proxy addresses.
<result/ addressListVisibilityDistinguishedName>	This parameter specifies the base distinguishedName for LDAP queries. It is used to limit the address list results in OWA for mutli-tenancy. Typical usage includes setting the value to the DN of the user's owning organization to allow visibility of all organization users. It can also be used to isolate a single user by setting the value to the DN of that user. Default to owning organization.
<result/ owningOrganization>	This parameter specifies the path of the hosted organization that contains the AL, GAL, and OAB as well-known-objects. By default, it is the LDAP parent container of the object.
<result/ offlineAddressBook>	This parameter specifies the associated address book.
<result/ database>	The unique path of the Exchange Database store.
<result/ issueWarningQuota>	This parameter specifies the mailbox size in bytes at which a warning message is sent to the user. You must specify either an integer or "unlimited." If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.
<result/ maxSendSize>	This parameter specifies the maximum size in bytes of messages that this mailbox can send. You must specify either an integer or "unlimited."
<result/ maxReceiveSize>	This parameter specifies the maximum size in bytes of messages that this mailbox can receive. You must specify either an integer or "unlimited."
<result/ prohibitSendQuota>	This parameter specifies the mailbox size in bytes at which the user associated with this mailbox can no longer send messages.
<result/ prohibitSendReceiveQuota>	This parameter specifies the mailbox size in bytes at which the user associated with this mailbox can no longer send or receive messages. You must specify either an integer or "unlimited." If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.
<result/ recipientLimits>	This parameter specifies the maximum number of recipients per message to which this mailbox can send. You must specify either an integer or "unlimited." If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.
<result/ hiddenFromAddressListsEnabled>	This parameter specifies whether this mailbox is hidden from other address lists.
<result/ imapEnabled>	This parameter specifies whether the IMAP4 protocol is enabled for this mailbox.
<result/ mapiEnabled>	This parameter specifies whether the MAPI protocol is enabled for this mailbox.
<result/ owaEnabled>	This parameter enables Outlook Web Access.
<result/ popEnabled>	This parameter specifies whether the POP3 protocol is enabled for this mailbox.
<result/ activeSyncAllowedDeviceIDs>	A list of device IDs that are allowed to synchronize with the mailbox.
<result/ activeSyncAllowedDeviceIDs/ value>	The device ID that is allowed to synchronize with the mailbox.
<result/ activeSyncDebugLogging>	This parameter specifies whether error logging is enabled for mobile devices.
<result/ activeSyncMailboxPolicy>	This parameter specifies whether an Exchange ActiveSync mailbox policy is applied for the mailbox.
<result/ activeSyncEnabled>	This parameter enables or disables Exchange ActiveSync.
<result/ hasActiveSyncDevicePartnership>	This parameter specifies whether the mailbox has a mobile device partnership established.
<result/ imapMessagesRetrievalMimeFormat>	This parameter specifies the format of messages that are retrieved from the server. Enum: TextOnly HtmlOnly HtmlAndTextAlternative TextEnrichedOnly TextEnrichedAndTextAlternative BestBodyFormat
<result/ imapUseProtocolDefaults>	This parameter specifies whether to use protocol defaults for the IMAP4 protocol.
<result/ mapiBlockOutlookNonCachedMode>	This parameter specifies whether Outlook can be used in non-cached mode.
<result/ mapiBlockOutlookRpcHttp>	This parameter specifies whether clients can connect to Outlook by using Outlook Anywhere.
<result/ mapiBlockOutlookVersions>	This parameter specifies versions of Outlook that are blocked.
<result/ mapiBlockOutlookVersions/ value>	One or more versions of MAPI client versions, in thhe format X.Y.Z (see http://support.microsoft.com/?kbid=288894).
<result/ owaActiveSyncIntegrationEnabled>	This parameter specifies whether Outlook Web Access Exchange ActiveSync mobile options are enabled.
<result/ owaAllAddressListsEnabled>	This parameter specifies whether all address lists are available in Outlook Web Access.
<result/ owaCalendarEnabled>	This parameter specifies whether calendaring is enabled in Outlook Web Access.
<result/ owaChangePasswordEnabled>	This parameter specifies whether a user can change their password in Outlook Web Access.
<result/ owaContactsEnabled>	This parameter specifies whether contacts are enabled in Outlook Web Access.
<result/ owaJournalEnabled>	This parameter specifies whether the Journal folder can be accessed in Outlook Web Access.
<result/ owaJunkEmailEnabled>	This parameter specifies whether junk e-mail is enabled in Outlook Web Access.
<result/ owaNotesEnabled>	This parameter specifies whether Sticky Notes are enabled in Outlook Web Access.
<result/ owaPremiumClientEnabled>	This parameter specifies whether Outlook Web Access Premium version is enabled.
<result/ owaRemindersAndNotificationsEnabled>	This parameter specifies whether calendar reminders are enabled in Outlook Web Access.
<result/ owaSearchFoldersEnabled>	This parameter specifies whether search folders are enabled in Outlook Web Access.
<result/ owaSignaturesEnabled>	This parameter specifies whether the signature feature is enabled in Outlook Web Access.
<result/ owaSpellCheckerEnabled >	This parameter specifies whether the spelling checker is enabled in Outlook Web Access.
<result/ owaTasksEnabled>	This parameter specifies whether tasks are enabled in Outlook Web Access.
<result/ owaThemeSelectionEnabled>	This parameter specifies whether theme selection is enabled in Outlook Web Access.
<result/ owaUMIntegrationEnabled>	This parameter specifies whether Unified Messaging (UM) integration is enabled in Outlook Web Access.
<result/ owaUNCAccessOnPrivateComputersEnabled>	This parameter specifies whether Universal Naming Convention (UNC) access is permitted when users select This is a private computer on the logon page.
<result/ owaUNCAccessOnPubicComputersEnabled>	This parameter specifies whether UNC access is permitted when users select This is a public or shared computer on the logon page.
<result/ owaWSSAccessOnPrivateComputersEnabled>	This parameter specifies whether SharePoint Portal Server access is permitted when users select This is a private computer on the logon page.
<result/ owaWSSAccessOnPublicComputersEnabled>	This parameter specifies whether SharePoint Portal Server access is permitted when users select This is a public or shared computer on the logon page.
<result/ popMessagesRetrievalMimeFormat>	This parameter specifies the format of messages that are retrieved from the server. Enum: HtmlOnly HtmlAndTextAlternative TextEnrichedOnly TextEnrichedAndTextAlternative BestBodyFormat
<result/ popUseProtocolDefaults>	This parameter specifies whether to use protocol defaults for the POP3 protocol.
<result/ owaPublicFoldersEnabled >	This parameter specifies whether the viewing of public folders is enabled in Outlook Web Access.
<result/ owaRecoverDeletedItemsEnabled >	This parameter specifies whether recovery of deleted items is enabled in Outlook Web Access.
<result/ owaRulesEnabled >	This parameter specifies whether rules can be accessed in Outlook Web Access. If this parameter is set to false, server rules will continue to function, but cannot be modified in Outlook Web Access.
<result/ owaSMimeEnabled >	This parameter specifies whether viewing of e-mail that is encrypted by using S/MIME is supported in Outlook Web Access.

Remarks

Schema Definition

Input

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

Output

<executeData> 
<result>1..1 
<alias>1..1 </alias>
<emailAddresses>1..1 
<value>1..unbounded </value>
</emailAddresses>
<addressListVisibilityDistinguishedName>0..1 </addressListVisibilityDistinguishedName>
<owningOrganization>0..1 </owningOrganization>
<offlineAddressBook>0..1 </offlineAddressBook>
<database>1..1 </database>
<issueWarningQuota>0..1 </issueWarningQuota>
<maxSendSize>0..1 </maxSendSize>
<maxReceiveSize>0..1 </maxReceiveSize>
<prohibitSendQuota>0..1 </prohibitSendQuota>
<prohibitSendReceiveQuota>0..1 </prohibitSendReceiveQuota>
<recipientLimits>0..1 </recipientLimits>
<hiddenFromAddressListsEnabled>0..1 </hiddenFromAddressListsEnabled>
<imapEnabled>0..1 </imapEnabled>
<mapiEnabled>0..1 </mapiEnabled>
<owaEnabled>0..1 </owaEnabled>
<popEnabled>0..1 </popEnabled>
<activeSyncAllowedDeviceIDs>0..1 
<value>1..unbounded </value>
</activeSyncAllowedDeviceIDs>
<activeSyncDebugLogging>0..1 </activeSyncDebugLogging>
<activeSyncMailboxPolicy>0..1 </activeSyncMailboxPolicy>
<activeSyncEnabled>0..1 </activeSyncEnabled>
<hasActiveSyncDevicePartnership>0..1 </hasActiveSyncDevicePartnership>
<imapMessagesRetrievalMimeFormat>0..1 </imapMessagesRetrievalMimeFormat>
<imapUseProtocolDefaults>0..1 </imapUseProtocolDefaults>
<mapiBlockOutlookNonCachedMode>0..1 </mapiBlockOutlookNonCachedMode>
<mapiBlockOutlookRpcHttp>0..1 </mapiBlockOutlookRpcHttp>
<mapiBlockOutlookVersions>0..1 
<value>1..unbounded </value>
</mapiBlockOutlookVersions>
<owaActiveSyncIntegrationEnabled>0..1 </owaActiveSyncIntegrationEnabled>
<owaAllAddressListsEnabled>0..1 </owaAllAddressListsEnabled>
<owaCalendarEnabled>0..1 </owaCalendarEnabled>
<owaChangePasswordEnabled>0..1 </owaChangePasswordEnabled>
<owaContactsEnabled>0..1 </owaContactsEnabled>
<owaJournalEnabled>0..1 </owaJournalEnabled>
<owaJunkEmailEnabled>0..1 </owaJunkEmailEnabled>
<owaNotesEnabled>0..1 </owaNotesEnabled>
<owaPremiumClientEnabled>0..1 </owaPremiumClientEnabled>
<owaRemindersAndNotificationsEnabled>0..1 </owaRemindersAndNotificationsEnabled>
<owaSearchFoldersEnabled>0..1 </owaSearchFoldersEnabled>
<owaSignaturesEnabled>0..1 </owaSignaturesEnabled>
<owaSpellCheckerEnabled>0..1 </owaSpellCheckerEnabled>
<owaTasksEnabled>0..1 </owaTasksEnabled>
<owaThemeSelectionEnabled>0..1 </owaThemeSelectionEnabled>
<owaUMIntegrationEnabled>0..1 </owaUMIntegrationEnabled>
<owaUNCAccessOnPrivateComputersEnabled>0..1 </owaUNCAccessOnPrivateComputersEnabled>
<owaUNCAccessOnPublicComputersEnabled>0..1 </owaUNCAccessOnPublicComputersEnabled>
<owaWSSAccessOnPrivateComputersEnabled>0..1 </owaWSSAccessOnPrivateComputersEnabled>
<owaWSSAccessOnPublicComputersEnabled>0..1 </owaWSSAccessOnPublicComputersEnabled>
<popMessagesRetrievalMimeFormat>0..1 </popMessagesRetrievalMimeFormat>
<popUseProtocolDefaults>0..1 </popUseProtocolDefaults>
<owaPublicFoldersEnabled>0..1 </owaPublicFoldersEnabled>
<owaRecoverDeletedItemsEnabled>0..1 </owaRecoverDeletedItemsEnabled>
<owaRulesEnabled>0..1 </owaRulesEnabled>
<owaSMimeEnabled>0..1 </owaSMimeEnabled>
</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=johnc@AlpineSkiHouse.com,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</user>
  </data>
  <procedure>
	<execute namespace="Hosted Email 2007" procedure="GetMailbox" 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>johnc.alpineskihouse.com</alias>
	<!--Specifies all 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>johnc@alpineskihouse.com</value>
	</emailAddresses>
	<!--Specifies the base distinguishedName for LDAP queries. Used to limit the address list results in OWA for mutli-tenancy.  Typical usage includes setting the value to the DN of the user's owning organization to allow visibility of all organization users. It can also be used to isolate a single user by setting the value to the DN of that user.  Default to owning organization.-->
	<addressListVisibilityDistinguishedName>OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</addressListVisibilityDistinguishedName>
	<!--Specifies the path of the hosted organization that contains the AL, GAL, and OAB as well-known-objects.  By default it is the LDAP parent container of the object.-->
	<owningOrganization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</owningOrganization>
	<!--Specifies the associated address book.-->
	<offlineAddressBook>LDAP://CN=AlpineSkiHouse OAB,CN=Offline Address Lists,CN=Address Lists Container,CN=Fabrikam,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=fabrikam,DC=com</offlineAddressBook>
	<!--The unique path of the Exchange Database store.-->
	<database>EXMBXCLUS01\SG01\HostedMailstore01</database>
	<!--Specifies the mailbox size at which a warning message is sent to the user.  You must specify either an integer or "unlimited."  If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.-->
	<issueWarningQuota>9000</issueWarningQuota>
	<!--Specifies the maximum size of messages that this mailbox can send. You must specify either an integer or "unlimited."-->
	<maxSendSize>10000</maxSendSize>
	<!--Specifies the maximum size of messages that this mailbox can receive. You must specify either an integer or "unlimited."-->
	<maxReceiveSize>10000</maxReceiveSize>
	<!--Specifies the mailbox size at which the user associated with this mailbox can no longer send messages.  You must specify either an integer or "unlimited."  If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.-->
	<prohibitSendQuota>10000</prohibitSendQuota>
	<!--Specifies the mailbox size at which the user associated with this mailbox can no longer send or receive messages.  You must specify either an integer or "unlimited."  If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.-->
	<prohibitSendReceiveQuota>20000</prohibitSendReceiveQuota>
	<!--Specifies the maximum number of recipients per message to which this mailbox can send.  You must specify either an integer or "unlimited."  If you set this attribute on a mailbox, that mailbox setting overrides the value that is set for this attribute on the mailbox database.-->
	<recipientLimits>100</recipientLimits>
	<!--Specifies whether this mailbox is hidden from other address lists.-->
	<hiddenFromAddressListsEnabled>true</hiddenFromAddressListsEnabled>
	<!--Specifies whether the IMAP4 protocol is enabled for this mailbox.-->
	<imapEnabled>true</imapEnabled>
	<!--Specifies whether the MAPI protocol is enabled for this mailbox.-->
	<mapiEnabled>true</mapiEnabled>
	<!--Enables Outlook Web Access.-->
	<owaEnabled>true</owaEnabled>
	<!--Specifies whether the POP3 protocol is enabled for this mailbox.-->
	<popEnabled>true</popEnabled>
	<!--A list of device IDs that are allowed to synchronize with the mailbox.-->
	<activeSyncAllowedDeviceIDs>
		<!--Device ID that is allowed to synchronize with the mailbox.-->
		<value>someID</value>
	</activeSyncAllowedDeviceIDs>
	<!--Specifies whether error logging is enabled for mobile devices.-->
	<activeSyncDebugLogging>2</activeSyncDebugLogging>
	<!--Specifies whether an Exchange ActiveSync mailbox policy is applied for the mailbox.-->
	<activeSyncMailboxPolicy>SalesMobilePolicy</activeSyncMailboxPolicy>
	<!--This parameter enables or disables Exchange ActiveSync.-->
	<activeSyncEnabled>true</activeSyncEnabled>
	<!--Specifies whether the mailbox has a mobile device partnership established.-->
	<hasActiveSyncDevicePartnership>false</hasActiveSyncDevicePartnership>
	<!--Specifies the format of messages that are retrieved from the server.-->
	<imapMessagesRetrievalMimeFormat>BestBodyFormat</imapMessagesRetrievalMimeFormat>
	<!--Specifies whether to use protocol defaults for the IMAP4 protocol.-->
	<imapUseProtocolDefaults>true</imapUseProtocolDefaults>
	<!--Specifies whether Outlook can be used in non-cached mode.-->
	<mapiBlockOutlookNonCachedMode>true</mapiBlockOutlookNonCachedMode>
	<!--Specifies whether clients can connect to Outlook by using Outlook Anywhere.-->
	<mapiBlockOutlookRpcHttp>false</mapiBlockOutlookRpcHttp>
	<!--Specifies versions of Outlook that are blocked.-->
	<mapiBlockOutlookVersions>
		<!--One or more versions of MAPI client versions, in thhe format X.Y.Z (see http://support.microsoft.com/?kbid=288894).-->
		<value>5.43.222</value>
	</mapiBlockOutlookVersions>
	<!--Specifies whether Outlook Web Access Exchange ActiveSync mobile options are enabled.-->
	<owaActiveSyncIntegrationEnabled>true</owaActiveSyncIntegrationEnabled>
	<!--Specifies whether all address lists are available in Outlook Web Access.-->
	<owaAllAddressListsEnabled>false</owaAllAddressListsEnabled>
	<!--Specifies whether calendaring is enabled in Outlook Web Access.-->
	<owaCalendarEnabled>true</owaCalendarEnabled>
	<!--Specifies whether a user can change their password in Outlook Web Access.-->
	<owaChangePasswordEnabled>false</owaChangePasswordEnabled>
	<!--Specifies whether contacts are enabled in Outlook Web Access.-->
	<owaContactsEnabled>true</owaContactsEnabled>
	<!--Specifies whether the Journal folder can be accessed in Outlook Web Access.-->
	<owaJournalEnabled>true</owaJournalEnabled>
	<!--Specifies whether junk e-mail is enabled in Outlook Web Access.-->
	<owaJunkEmailEnabled>true</owaJunkEmailEnabled>
	<!--Specifies whether Sticky Notes are enabled in Outlook Web Access.-->
	<owaNotesEnabled>true</owaNotesEnabled>
	<!--Specifies whether Outlook Web Access Premium version is enabled.-->
	<owaPremiumClientEnabled>true</owaPremiumClientEnabled>
	<!--Specifies whether calendar reminders are enabled in Outlook Web Access.-->
	<owaRemindersAndNotificationsEnabled>true</owaRemindersAndNotificationsEnabled>
	<!--Specifies whether search folders are enabled in Outlook Web Access.-->
	<owaSearchFoldersEnabled>true</owaSearchFoldersEnabled>
	<!--Specifies whether the signature feature is enabled in Outlook Web Access.-->
	<owaSignaturesEnabled>true</owaSignaturesEnabled>
	<!--Specifies whether the spelling checker is enabled in Outlook Web Access.-->
	<owaSpellCheckerEnabled>true</owaSpellCheckerEnabled>
	<!--Specifies whether tasks are enabled in Outlook Web Access.-->
	<owaTasksEnabled>true</owaTasksEnabled>
	<!--Specifies whether theme selection is enabled in Outlook Web Access.-->
	<owaThemeSelectionEnabled>true</owaThemeSelectionEnabled>
	<!--Specifies whether Unified Messaging (UM) integration is enabled in Outlook Web Access.-->
	<owaUMIntegrationEnabled>true</owaUMIntegrationEnabled>
	<!--Specifies whether Universal Naming Convention (UNC) access is permitted when users select This is a private computer on the logon page.-->
	<owaUNCAccessOnPrivateComputersEnabled>true</owaUNCAccessOnPrivateComputersEnabled>
	<!--Specifies whether UNC access is permitted when users select This is a public or shared computer on the logon page.-->
	<owaUNCAccessOnPublicComputersEnabled>true</owaUNCAccessOnPublicComputersEnabled>
	<!--Specifies whether SharePoint Portal Server access is permitted when users select This is a private computer on the logon page.-->
	<owaWSSAccessOnPrivateComputersEnabled>true</owaWSSAccessOnPrivateComputersEnabled>
	<!--Specifies whether SharePoint Portal Server access is permitted when users select This is a public or shared computer on the logon page.-->
	<owaWSSAccessOnPublicComputersEnabled>true</owaWSSAccessOnPublicComputersEnabled>
	<!--Specifies the format of messages that are retrieved from the server.-->
	<popMessagesRetrievalMimeFormat>BestBodyFormat</popMessagesRetrievalMimeFormat>
	<!--Specifies whether to use protocol defaults for the POP3 protocol.-->
	<popUseProtocolDefaults>true</popUseProtocolDefaults>
	<!--Specifies whether the viewing of public folders is enabled in Outlook Web Access.-->
	<owaPublicFoldersEnabled>true</owaPublicFoldersEnabled>
	<!--Specifies whether recovery of deleted items is enabled in Outlook Web Access.-->
	<owaRecoverDeletedItemsEnabled>true</owaRecoverDeletedItemsEnabled>
	<!--Specifies whether rules can be accessed in Outlook Web Access. If this parameter is set to false, server rules will continue to function, but cannot be modified in Outlook Web Access.-->
	<owaRulesEnabled>true</owaRulesEnabled>
	<!--Specifies whether viewing of e-mail that is encrypted by using S/MIME is supported in Outlook Web Access.-->
	<owaSMimeEnabled>true</owaSMimeEnabled>
	<!--Specifies whether the mailbox is a resource mailbox.-->
	<isResource>false</isResource>
	</result>
  </data>
</response>

Applies To