Managed Email 2007::ModifyMailbox
Modifies mailbox properties for an existing user.
Arguments
| Input Arguments | Required | Description |
|---|---|---|
<preferredDomainController> |
Yes |
The domain controller to use for Active Directory actions. |
<user> |
Yes |
Specifies the LDAP path of the user object of the mailbox to be modified. |
<alias> |
No |
Sets the e-mail alias of the mailbox that you are modifying. The alias can be a combination of characters separated by a period with no intervening spaces. Do not use special characters in the alias. |
<emailAddresses> |
No |
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>/ <value> |
Yes |
Specifies all the proxy addresses of the mailbox. It includes the primary SMTP address as one of the proxy addresses. |
<addressListVisibilityDistinguishedName> |
No |
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. |
<offlineAddressBook> |
No |
Specifies the associated address book. |
< issueWarningQuota> |
No |
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. |
<maxSendSize> |
No |
Specifies the maximum size of messages that this mailbox can send. You must specify either an integer or "unlimited. |
<maxReceiveSize> |
No |
Specifies the maximum size of messages that this mailbox can receive. You must specify either an integer or "unlimited." |
<prohibitSendQuota> |
No |
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. |
<prohibitSendReceiveQuota> |
No |
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. |
<recipientLimits> |
No |
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. |
<hiddenFromAddressListsEnabled> |
No |
Specifies whether this mailbox is hidden from other address lists. |
<imapEnabled> |
No |
Specifies whether the IMAP4 protocol is enabled for this mailbox. |
<popEnabled> |
No |
Specifies whether the POP3 protocol is enabled for this mailbox. |
<owaEnabled> |
No |
Enables Outlook Web Access. |
<mapiEnabled> |
No |
Specifies whether the MAPI protocol is enabled for this mailbox. |
<activeSyncEnabled> |
No |
Specifies whether the ActiveSync is enabled for this mailbox. |
<mapiBlockOutlookNonCachedMode> |
No |
Specifies whether Outlook can be used in non-cached mode. |
<mapiBlockOutlookRpcHttp> |
No |
Specifies whether clients can connect to Outlook by using Outlook Anywhere. |
<mapiBlockOutlookVersions> |
No |
Specifies versions of Outlook that are blocked. |
<mapiBlockOutlookVersions>/ <value > |
Yes |
One or more versions of MAPI client versions, in thhe format X.Y.Z. |
<owaAllAddressListsEnabled> |
No |
Specifies whether all address lists are available in Outlook Web Access. |
<owaContactsEnabled> |
No |
Specifies whether contacts are enabled in Outlook Web Access. |
<owaCalendarEnabled> |
No |
Specifies whether calendaring is enabled in Outlook Web Access. |
<owaChangePasswordEnabled> |
No |
Specifies whether a user can change their password in Outlook Web Access. |
<owaJournalEnabled> |
No |
Specifies whether the Journal folder can be accessed in Outlook Web Access. |
<owaTasksEnabled> |
No |
Specifies whether tasks are enabled in Outlook Web Access. |
<owaNotesEnabled> |
No |
Specifies whether Sticky Notes are enabled in Outlook Web Access. |
<owaRemindersAndNotificationsEnabled> |
No |
Specifies whether calendar reminders are enabled in Outlook Web Access. |
<owaPremiumClientEnabled> |
No |
Specifies whether Outlook Web Access Premium version is enabled. |
<owaSpellCheckerEnabled> |
No |
Specifies whether the spelling checker is enabled in Outlook Web Access. |
<owaSearchFoldersEnabled> |
No |
Specifies whether search folders are enabled in Outlook Web Access. |
<owaSignaturesEnabled> |
No |
Specifies whether the signature feature is enabled in Outlook Web Access. |
<owaThemeSelectionEnabled> |
No |
Specifies whether theme selection is enabled in Outlook Web Access. |
<owaJunkEmailEnabled> |
No |
Specifies whether junk e-mail is enabled in Outlook Web Access. |
<owaUMIntegrationEnabled> |
No |
Specifies whether Unified Messaging (UM) integration is enabled in Outlook Web Access. |
<owaActiveSyncIntegrationEnabled> |
No |
Specifies whether Outlook Web Access Exchange ActiveSync mobile options are enabled. |
<owaUNCAccessOnPrivateComputersEnabled> |
No |
Specifies whether Universal Naming Convention (UNC) access is permitted when users select This is a private computer on the logon page. |
<owaUNCAccessOnPublicComputersEnabled> |
No |
Specifies whether UNC access is permitted when users select This is a public or shared computer on the logon page. |
<owaWSSAccessOnPrivateComputersEnabled> |
No |
Specifies whether SharePoint Portal Server access is permitted when users select This is a private computer on the logon page. |
<owaWSSAccessOnPublicComputersEnabled> |
No |
Specifies whether SharePoint Portal Server access is permitted when users select This is a public or shared computer on the logon page. |
<owaPublicFoldersEnabled> |
No |
Specifies whether the viewing of public folders is enabled in Outlook Web Access. |
<owaRecoverDeletedItemsEnabled> |
No |
Specifies whether recovery of deleted items is enabled in Outlook Web Access. |
<owaRulesEnabled> |
No |
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. |
<owaSMimeEnabled> |
No |
Specifies whether viewing of e-mail that is encrypted by using S/MIME is supported in Outlook Web Access. |
Remarks
Security
Caller must be at least a member of role: UserCreators.
Schema Defination
Request
<executeData>
<preferredDomainController>1..1 </preferredDomainController>
<user>1..1 </user>
<alias>0..1 </alias>
<emailAddresses>0..1
<value>1..unbounded </value>
</emailAddresses>
<addressListVisibilityDistinguishedName>0..1 </addressListVisibilityDistinguishedName>
<offlineAddressBook>0..1 </offlineAddressBook>
<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>
<popEnabled>0..1 </popEnabled>
<owaEnabled>0..1 </owaEnabled>
<mapiEnabled>0..1 </mapiEnabled>
<activeSyncEnabled>0..1 </activeSyncEnabled>
<mapiBlockOutlookNonCachedMode>0..1 </mapiBlockOutlookNonCachedMode>
<mapiBlockOutlookRpcHttp>0..1 </mapiBlockOutlookRpcHttp>
<mapiBlockOutlookVersions>0..1
<value>1..unbounded </value>
</mapiBlockOutlookVersions>
<owaAllAddressListsEnabled>0..1 </owaAllAddressListsEnabled>
<owaContactsEnabled>0..1 </owaContactsEnabled>
<owaCalendarEnabled>0..1 </owaCalendarEnabled>
<owaChangePasswordEnabled>0..1 </owaChangePasswordEnabled>
<owaJournalEnabled>0..1 </owaJournalEnabled>
<owaTasksEnabled>0..1 </owaTasksEnabled>
<owaNotesEnabled>0..1 </owaNotesEnabled>
<owaRemindersAndNotificationsEnabled>0..1 </owaRemindersAndNotificationsEnabled>
<owaPremiumClientEnabled>0..1 </owaPremiumClientEnabled>
<owaSpellCheckerEnabled>0..1 </owaSpellCheckerEnabled>
<owaSearchFoldersEnabled>0..1 </owaSearchFoldersEnabled>
<owaSignaturesEnabled>0..1 </owaSignaturesEnabled>
<owaThemeSelectionEnabled>0..1 </owaThemeSelectionEnabled>
<owaJunkEmailEnabled>0..1 </owaJunkEmailEnabled>
<owaUMIntegrationEnabled>0..1 </owaUMIntegrationEnabled>
<owaActiveSyncIntegrationEnabled>0..1 </owaActiveSyncIntegrationEnabled>
<owaUNCAccessOnPrivateComputersEnabled>0..1 </owaUNCAccessOnPrivateComputersEnabled>
<owaUNCAccessOnPublicComputersEnabled>0..1 </owaUNCAccessOnPublicComputersEnabled>
<owaWSSAccessOnPrivateComputersEnabled>0..1 </owaWSSAccessOnPrivateComputersEnabled>
<owaWSSAccessOnPublicComputersEnabled>0..1 </owaWSSAccessOnPublicComputersEnabled>
<owaPublicFoldersEnabled>0..1 </owaPublicFoldersEnabled>
<owaRecoverDeletedItemsEnabled>0..1 </owaRecoverDeletedItemsEnabled>
<owaRulesEnabled>0..1 </owaRulesEnabled>
<owaSMimeEnabled>0..1 </owaSMimeEnabled>
</executeData>
Response
<executeData>1..1 </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 of the mailbox to be modified.-->
<user>LDAP://CN=johnc@alpineskihouse.com,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=fabrikam,DC=com</user>
<!--Sets the e-mail alias of the mailbox that you are modifying. The alias can be a combination of characters separated by a period with no intervening spaces. Do not use special characters in the alias-->
<alias>johnc</alias>
<!--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>
<!--Specifies all the proxy addresses of the mailbox. It includes the primary Simple Mail Transfer Protocol (SMTP) address as one of the proxy addresses.-->
<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 associated address book.-->
<offlineAddressBook>LDAP://CN=AlpineSkiHouse OAL,CN=Offline Address Lists,CN=Address Lists Container,CN=Fabrikam,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=fabrikam,DC=com</offlineAddressBook>
<!--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 POP3 protocol is enabled for this mailbox.-->
<popEnabled>true</popEnabled>
<!--Enables Outlook Web Access.-->
<owaEnabled>true</owaEnabled>
<!--Specifies whether the MAPI protocol is enabled for this mailbox.-->
<mapiEnabled>true</mapiEnabled>
<!--Specifies whether ActiveSync is enabled for this mailbox.-->
<activeSyncEnabled>true</activeSyncEnabled>
<!--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 https://support.microsoft.com/?kbid=288894).-->
<value>5.2653.22</value>
</mapiBlockOutlookVersions>
<!--Specifies whether all address lists are available in Outlook Web Access.-->
<owaAllAddressListsEnabled>false</owaAllAddressListsEnabled>
<!--Specifies whether contacts are enabled in Outlook Web Access.-->
<owaContactsEnabled>true</owaContactsEnabled>
<!--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 the Journal folder can be accessed in Outlook Web Access.-->
<owaJournalEnabled>true</owaJournalEnabled>
<!--Specifies whether tasks are enabled in Outlook Web Access.-->
<owaTasksEnabled>true</owaTasksEnabled>
<!--Specifies whether Sticky Notes are enabled in Outlook Web Access.-->
<owaNotesEnabled>true</owaNotesEnabled>
<!--Specifies whether calendar reminders are enabled in Outlook Web Access.-->
<owaRemindersAndNotificationsEnabled>true</owaRemindersAndNotificationsEnabled>
<!--Specifies whether Outlook Web Access Premium version is enabled.-->
<owaPremiumClientEnabled>true</owaPremiumClientEnabled>
<!--Specifies whether the spelling checker is enabled in Outlook Web Access.-->
<owaSpellCheckerEnabled>true</owaSpellCheckerEnabled>
<!--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 theme selection is enabled in Outlook Web Access.-->
<owaThemeSelectionEnabled>true</owaThemeSelectionEnabled>
<!--Specifies whether junk e-mail is enabled in Outlook Web Access.-->
<owaJunkEmailEnabled>true</owaJunkEmailEnabled>
<!--Specifies whether Unified Messaging (UM) integration is enabled in Outlook Web Access.-->
<owaUMIntegrationEnabled>true</owaUMIntegrationEnabled>
<!--Specifies whether Outlook Web Access Exchange ActiveSync mobile options are enabled.-->
<owaActiveSyncIntegrationEnabled>true</owaActiveSyncIntegrationEnabled>
<!--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 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>
</data>
<procedure>
<execute namespace="Managed Email 2007" procedure="ModifyMailbox" impersonate="1">
<before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" />
<before source="data" sourcePath="user" destination="executeData" mode="move" />
<before source="data" sourcePath="alias" destination="executeData" mode="move" />
<before source="data" sourcePath="emailAddresses" destination="executeData" mode="move" />
<before source="data" sourcePath="addressListVisibilityDistinguishedName" destination="executeData" mode="move" />
<before source="data" sourcePath="offlineAddressBook" destination="executeData" mode="move" />
<before source="data" sourcePath="issueWarningQuota" destination="executeData" mode="move" />
<before source="data" sourcePath="maxSendSize" destination="executeData" mode="move" />
<before source="data" sourcePath="maxReceiveSize" destination="executeData" mode="move" />
<before source="data" sourcePath="prohibitSendQuota" destination="executeData" mode="move" />
<before source="data" sourcePath="prohibitSendReceiveQuota" destination="executeData" mode="move" />
<before source="data" sourcePath="recipientLimits" destination="executeData" mode="move" />
<before source="data" sourcePath="hiddenFromAddressListsEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="imapEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="popEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="mapiEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="activeSyncEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="mapiBlockOutlookNonCachedMode" destination="executeData" mode="move" />
<before source="data" sourcePath="mapiBlockOutlookRpcHttp" destination="executeData" mode="move" />
<before source="data" sourcePath="mapiBlockOutlookVersions" destination="executeData" mode="move" />
<before source="data" sourcePath="owaAllAddressListsEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaContactsEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaCalendarEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaChangePasswordEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaJournalEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaTasksEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaNotesEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaRemindersAndNotificationsEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaPremiumClientEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaSpellCheckerEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaSearchFoldersEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaSignaturesEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaThemeSelectionEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaJunkEmailEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaUMIntegrationEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaActiveSyncIntegrationEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaUNCAccessOnPrivateComputersEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaUNCAccessOnPublicComputersEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaWSSAccessOnPrivateComputersEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaWSSAccessOnPublicComputersEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaPublicFoldersEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaRecoverDeletedItemsEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaRulesEnabled" destination="executeData" mode="move" />
<before source="data" sourcePath="owaSMimeEnabled" destination="executeData" mode="move" />
<after source="executeData" destination="data" mode="merge" />
</execute>
</procedure>
</request>
Applies To
Hosted Messaging and Collaboration version 4.5
Hosted Messaging and Collaboration version 4.0
See also
Other Resources
API Name [HMC SDK]
API Name [HMC SDK]
API Name [HMC SDK]
API Name [HMC SDK]
API Name [HMC SDK]
API Name [HMC SDK]