[MS-OXWSSMBX]:

Site Mailbox Web Service Protocol

Intellectual Property Rights Notice for Open Specifications Documentation

 Technical Documentation. Microsoft publishes Open Specifications documentation (“this
documentation”) for protocols, file formats, data portability, computer languages, and standards
support. Additionally, overview documents cover inter-protocol relationships and interactions.
 Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other
terms that are contained in the terms of use for the Microsoft website that hosts this
documentation, you can make copies of it in order to develop implementations of the technologies
that are described in this documentation and can distribute portions of it in your implementations
that use these technologies or in your documentation as necessary to properly document the
implementation. You can also distribute in your implementation, with or without modification, any
schemas, IDLs, or code samples that are included in the documentation. This permission also
applies to any documents that are referenced in the Open Specifications documentation.
 No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.
 Patents. Microsoft has patents that might cover your implementations of the technologies
described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of
this documentation grants any licenses under those patents or any other Microsoft patents.
However, a given Open Specifications document might be covered by the Microsoft Open
Specifications Promise or the Microsoft Community Promise. If you would prefer a written license,
or if the technologies described in this documentation are not covered by the Open Specifications
Promise or Community Promise, as applicable, patent licenses are available by contacting
[email protected].
 License Programs. To see all of the protocols in scope under a specific license program and the
associated patents, visit the Patent Map.
 Trademarks. The names of companies and products contained in this documentation might be
covered by trademarks or similar intellectual property rights. This notice does not grant any
licenses under those rights. For a list of Microsoft trademarks, visit
www.microsoft.com/trademarks.
 Fictitious Names. The example companies, organizations, products, domain names, email
addresses, logos, people, places, and events that are depicted in this documentation are fictitious.
No association with any real company, organization, product, domain name, email address, logo,
person, place, or event is intended or should be inferred.
Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other
than as specifically described above, whether by implication, estoppel, or otherwise.

Tools. The Open Specifications documentation does not require the use of Microsoft programming
tools or programming environments in order for you to develop an implementation. If you have access
to Microsoft programming tools and environments, you are free to take advantage of them. Certain
Open Specifications documents are intended for use in conjunction with publicly available standards
specifications and network programming art and, as such, assume that the reader either is familiar
with the aforementioned material or has immediate access to it.

Support. For questions and support, please contact [email protected].

1 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
Revision Summary

Revision Revision
Date History Class Comments

7/16/2012 0.1 New Released new document.

10/8/2012 1.0 Major Significantly changed the technical content.

No changes to the meaning, language, or formatting of the

2/11/2013 1.0 None
technical content.

No changes to the meaning, language, or formatting of the

7/26/2013 1.0 None
technical content.

No changes to the meaning, language, or formatting of the

11/18/2013 1.0 None
technical content.

No changes to the meaning, language, or formatting of the

2/10/2014 1.0 None
technical content.

4/30/2014 1.1 Minor Clarified the meaning of the technical content.

No changes to the meaning, language, or formatting of the

7/31/2014 1.1 None
technical content.

10/30/2014 1.2 Minor Clarified the meaning of the technical content.

3/16/2015 2.0 Major Significantly changed the technical content.

No changes to the meaning, language, or formatting of the

5/26/2015 2.0 None
technical content.

No changes to the meaning, language, or formatting of the

9/14/2015 2.0 None
technical content.

No changes to the meaning, language, or formatting of the

6/13/2016 2.0 None
technical content.

No changes to the meaning, language, or formatting of the

9/14/2016 2.0 None
technical content.

No changes to the meaning, language, or formatting of the

9/19/2017 2.0 None
technical content.

7/24/2018 3.0 Major Significantly changed the technical content.

10/1/2018 4.0 Major Significantly changed the technical content.

2 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
Table of Contents
1 Introduction ............................................................................................................ 5
1.1 Glossary ........................................................................................................... 5
1.2 References ........................................................................................................ 6
1.2.1 Normative References ................................................................................... 6
1.2.2 Informative References ................................................................................. 7
1.3 Overview .......................................................................................................... 7
1.4 Relationship to Other Protocols ............................................................................ 7
1.5 Prerequisites/Preconditions ................................................................................. 8
1.6 Applicability Statement ....................................................................................... 8
1.7 Versioning and Capability Negotiation ................................................................... 8
1.8 Vendor-Extensible Fields ..................................................................................... 8
1.9 Standards Assignments....................................................................................... 8
2 Messages ................................................................................................................. 9
2.1 Transport .......................................................................................................... 9
2.2 Common Message Syntax ................................................................................... 9
2.2.1 Namespaces ................................................................................................ 9
2.2.2 Messages..................................................................................................... 9
2.2.3 Elements ..................................................................................................... 9
2.2.4 Complex Types ........................................................................................... 10
2.2.5 Simple Types ............................................................................................. 10
2.2.6 Attributes .................................................................................................. 10
2.2.7 Groups ...................................................................................................... 10
2.2.8 Attribute Groups ......................................................................................... 10
3 Protocol Details ..................................................................................................... 11
3.1 ExchangeServicePortType Server Details ............................................................. 11
3.1.1 Abstract Data Model .................................................................................... 11
3.1.2 Timers ...................................................................................................... 11
3.1.3 Initialization ............................................................................................... 11
3.1.4 Message Processing Events and Sequencing Rules .......................................... 11
3.1.4.1 SetTeamMailbox ................................................................................... 11
3.1.4.1.1 Messages ....................................................................................... 12
3.1.4.1.1.1 SetTeamMailboxSoapIn .............................................................. 12
3.1.4.1.1.2 SetTeamMailboxSoapOut ............................................................ 13
3.1.4.1.2 Elements ........................................................................................ 13
3.1.4.1.2.1 SetTeamMailbox ........................................................................ 14
3.1.4.1.2.2 SetTeamMailboxResponse ........................................................... 14
3.1.4.1.3 Complex Types ............................................................................... 14
3.1.4.1.3.1 SetTeamMailboxRequestType ...................................................... 14
3.1.4.1.3.2 SetTeamMailboxResponseMessageType ........................................ 15
3.1.4.1.4 Simple Types .................................................................................. 15
3.1.4.1.4.1 TeamMailboxLifecycleStateType ................................................... 15
3.1.4.1.5 Attributes ....................................................................................... 16
3.1.4.1.6 Groups ........................................................................................... 16
3.1.4.1.7 Attribute Groups.............................................................................. 16
3.1.4.2 UnpinTeamMailbox ................................................................................ 16
3.1.4.2.1 Messages ....................................................................................... 17
3.1.4.2.1.1 UnpinTeamMailboxSoapIn ........................................................... 17
3.1.4.2.1.2 UnpinTeamMailboxSoapOut ......................................................... 17
3.1.4.2.2 Elements ........................................................................................ 18
3.1.4.2.2.1 UnpinTeamMailbox ..................................................................... 18
3.1.4.2.2.2 UnpinTeamMailboxResponse ....................................................... 18
3.1.4.2.3 Complex Types ............................................................................... 19
3.1.4.2.3.1 UnpinTeamMailboxRequestType ................................................... 19

3 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
 3.1.4.2.3.2 UnpinTeamMailboxResponseMessageType ..................................... 19
3.1.4.2.4 Simple Types .................................................................................. 19
3.1.4.2.5 Attributes ....................................................................................... 19
3.1.4.2.6 Groups ........................................................................................... 20
3.1.4.2.7 Attribute Groups.............................................................................. 20
3.1.5 Timer Events .............................................................................................. 20
3.1.6 Other Local Events ...................................................................................... 20
4 Protocol Examples ................................................................................................. 21
5 Security ................................................................................................................. 22
5.1 Security Considerations for Implementers ........................................................... 22
5.2 Index of Security Parameters ............................................................................ 22
6 Appendix A: Full WSDL .......................................................................................... 23
7 Appendix B: Full XML Schema ................................................................................ 25
7.1 http://schemas.microsoft.com/exchange/services/2006/messages Schema ............ 25
7.2 http://schemas.microsoft.com/exchange/services/2006/types Schema ................... 26
8 Appendix C: Product Behavior ............................................................................... 27
9 Change Tracking .................................................................................................... 28
10 Index ..................................................................................................................... 29

4 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
1 Introduction
The Site Mailbox Web Service Protocol enables clients to use a web service to manage access to site
mailboxes. It provides operations to set the lifecycle state of a site mailbox or unpin it from the
client.

Sections 1.5, 1.8, 1.9, 2, and 3 of this specification are normative. All other sections and examples in
this specification are informative.

1.1 Glossary

This document uses the following terms:

email address: A string that identifies a user and enables the user to receive Internet messages.

endpoint: A communication port that is exposed by an application server for a specific shared
service and to which messages can be addressed.

Hypertext Transfer Protocol (HTTP): An application-level protocol for distributed, collaborative,

hypermedia information systems (text, graphic images, sound, video, and other multimedia
files) on the World Wide Web.

Hypertext Transfer Protocol Secure (HTTPS): An extension of HTTP that securely encrypts and
decrypts web page requests. In some older protocols, "Hypertext Transfer Protocol over Secure
Sockets Layer" is still used (Secure Sockets Layer has been deprecated). For more information,
see [SSL3] and [RFC5246].

mailbox: A message store that contains email, calendar items, and other Message objects for a
single recipient.

site mailbox: A repository comprised of a mailbox and a web-based collaboration environment

that is presented to users as a mailbox in an email client. A site mailbox uses team membership
to determine which users have access to the repository.

SOAP: A lightweight protocol for exchanging structured information in a decentralized, distributed

environment. SOAP uses XML technologies to define an extensible messaging framework, which
provides a message construct that can be exchanged over a variety of underlying protocols. The
framework has been designed to be independent of any particular programming model and
other implementation-specific semantics. SOAP 1.2 supersedes SOAP 1.1. See [SOAP1.2-
1/2003].

SOAP action: The HTTP request header field used to indicate the intent of the SOAP request,
using a URI value. See [SOAP1.1] section 6.1.1 for more information.

SOAP body: A container for the payload data being delivered by a SOAP message to its recipient.
See [SOAP1.2-1/2007] section 5.3 for more information.

SOAP header: A mechanism for implementing extensions to a SOAP message in a decentralized

manner without prior agreement between the communicating parties. See [SOAP1.2-1/2007]
section 5.2 for more information.

Uniform Resource Locator (URL): A string of characters in a standardized format that identifies
a document or resource on the World Wide Web. The format is as specified in [RFC1738].

web server: A server computer that hosts websites and responds to requests from applications.

web service: A unit of application logic that provides data and services to other applications and
can be called by using standard Internet transport protocols such as HTTP, Simple Mail Transfer

5 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
 Protocol (SMTP), or File Transfer Protocol (FTP). Web services can perform functions that range
from simple requests to complicated business processes.

Web Services Description Language (WSDL): An XML format for describing network services
as a set of endpoints that operate on messages that contain either document-oriented or
procedure-oriented information. The operations and messages are described abstractly and are
bound to a concrete network protocol and message format in order to define an endpoint.
Related concrete endpoints are combined into abstract endpoints, which describe a network
service. WSDL is extensible, which allows the description of endpoints and their messages
regardless of the message formats or network protocols that are used.

WSDL message: An abstract, typed definition of the data that is communicated during a WSDL
operation [WSDL]. Also, an element that describes the data being exchanged between web
service providers and clients.

WSDL operation: A single action or function of a web service. The execution of a WSDL operation
typically requires the exchange of messages between the service requestor and the service
provider.

WSDL port type: A named set of logically-related, abstract Web Services Description
Language (WSDL) operations and messages.

XML namespace: A collection of names that is used to identify elements, types, and attributes in
XML documents identified in a URI reference [RFC3986]. A combination of XML namespace and
local name allows XML documents to use elements, types, and attributes that have the same
names but come from different sources. For more information, see [XMLNS-2ED].

XML namespace prefix: An abbreviated form of an XML namespace, as described in [XML].

XML schema: A description of a type of XML document that is typically expressed in terms of
constraints on the structure and content of documents of that type, in addition to the basic
syntax constraints that are imposed by XML itself. An XML schema provides a view of a
document type at a relatively high level of abstraction.

MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as defined
in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT.

1.2 References

Links to a document in the Microsoft Open Specifications library point to the correct section in the
most recently published version of the referenced document. However, because individual documents
in the library are not updated at the same time, the section numbers in the documents may not
match. You can confirm the correct section numbering by checking the Errata.

1.2.1 Normative References

We conduct frequent surveys of the normative references to assure their continued availability. If you
have any issue with finding a normative reference, please contact [email protected]. We will
assist you in finding the relevant information.

[MS-OXDSCLI] Microsoft Corporation, "Autodiscover Publishing and Lookup Protocol".

[MS-OXWSADISC] Microsoft Corporation, "Autodiscover Publishing and Lookup SOAP-Based Web

Service Protocol".

[MS-OXWSCDATA] Microsoft Corporation, "Common Web Service Data Types".

[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC
2119, March 1997, http://www.rfc-editor.org/rfc/rfc2119.txt

6 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
[RFC2616] Fielding, R., Gettys, J., Mogul, J., et al., "Hypertext Transfer Protocol -- HTTP/1.1", RFC
2616, June 1999, http://www.rfc-editor.org/rfc/rfc2616.txt

[RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000, http://www.rfc-
editor.org/rfc/rfc2818.txt

[SOAP1.1] Box, D., Ehnebuske, D., Kakivaya, G., et al., "Simple Object Access Protocol (SOAP) 1.1",
W3C Note, May 2000, http://www.w3.org/TR/2000/NOTE-SOAP-20000508/

[WSDL] Christensen, E., Curbera, F., Meredith, G., and Weerawarana, S., "Web Services Description
Language (WSDL) 1.1", W3C Note, March 2001, http://www.w3.org/TR/2001/NOTE-wsdl-20010315

[WSIBASIC] Ballinger, K., Ehnebuske, D., Gudgin, M., et al., Eds., "Basic Profile Version 1.0", Final
Material, April 2004, http://www.ws-i.org/Profiles/BasicProfile-1.0-2004-04-16.html

[XMLNS] Bray, T., Hollander, D., Layman, A., et al., Eds., "Namespaces in XML 1.0 (Third Edition)",
W3C Recommendation, December 2009, http://www.w3.org/TR/2009/REC-xml-names-20091208/

[XMLSCHEMA1/2] Thompson, H., Beech, D., Maloney, M., and Mendelsohn, N., Eds., "XML Schema
Part 1: Structures Second Edition", W3C Recommendation, October 2004,
http://www.w3.org/TR/2004/REC-xmlschema-1-20041028/

[XMLSCHEMA1] Thompson, H., Beech, D., Maloney, M., and Mendelsohn, N., Eds., "XML Schema Part
1: Structures", W3C Recommendation, May 2001, http://www.w3.org/TR/2001/REC-xmlschema-1-
20010502/

[XMLSCHEMA2/2] Biron, P., and Malhotra, A., Eds., "XML Schema Part 2: Datatypes Second Edition",
W3C Recommendation, October 2004, http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/

[XMLSCHEMA2] Biron, P.V., Ed. and Malhotra, A., Ed., "XML Schema Part 2: Datatypes", W3C
Recommendation, May 2001, http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/

1.2.2 Informative References

[MS-OXPROTO] Microsoft Corporation, "Exchange Server Protocols System Overview".

1.3 Overview

Site mailboxes differ from primary mailboxes in that multiple users can access a site mailbox, while
only a single user accesses a primary mailbox. A site mailbox can have multiple owners, members,
and guests, each with a different level of permissions.

The Site Mailbox Web Service Protocol provides operations to set the lifecycle state of a site mailbox
or unpin a site mailbox from a client.

1.4 Relationship to Other Protocols

A client that implements this protocol can use the Autodiscover Publishing and Lookup SOAP-Based
Web Service Protocol, as described in [MS-OXWSADISC], or the Autodiscover Publishing and Lookup
Protocol, as described in [MS-OXDSCLI], to identify the target endpoint to use for each operation.

This protocol uses SOAP, as described in [SOAP1.1], to specify the structure information that is
exchanged between the client and the server. This protocol uses the XML schema, as described in
[XMLSCHEMA1] and [XMLSCHEMA2], to describe the message content that is sent to and from the
server.

This protocol uses SOAP over HTTP, as described in [RFC2616], and SOAP over HTTPS, as described
in [RFC2818], as shown in the following layering diagram.

7 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
Figure 1: This protocol in relation to other protocols

For conceptual background information and overviews of the relationships and interactions between
this and other protocols, see [MS-OXPROTO].

1.5 Prerequisites/Preconditions

The operations that this protocol defines cannot be accessed unless the correct endpoint is identified
in the HTTP web requests that target this protocol. This endpoint URL is returned by either the
Autodiscover Publishing Lookup SOAP-Based Web Service Protocol, as specified in [MS-OXWSADISC],
or the Autodiscover Publishing and Lookup Protocol, as specified in [MS-OXDSCLI].

1.6 Applicability Statement

This protocol is applicable to environments that use web services to implement site mailboxes. This
protocol is applicable to all SOAP-based clients, as described in [SOAP1.1].

1.7 Versioning and Capability Negotiation

This document covers versioning issues in the following areas:

 Supported Transports: This protocol uses SOAP 1.1, as described in section 2.1.

 Protocol Versions: This protocol specifies only one WSDL port type version. The
RequestServerVersion element, as described in [MS-OXWSCDATA] section 2.2.3.9, identifies
the WSDL port type version of the request. The ServerVersionInfo element, as described in
[MS-OXWSCDATA] section 2.2.3.10, identifies the version of the server responding to the request.

 Security and Authentication Methods: This protocol relies on the web server that is hosting it
to perform authentication.

 Capability Negotiation: This protocol does not support version negotiation.

1.8 Vendor-Extensible Fields

None.

1.9 Standards Assignments

None.

8 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
2 Messages
In the following sections, the schema definition might differ from the processing rules imposed by the
protocol. The WSDL in this specification provides a base description of the protocol. The schema in
this specification provides a base description of the message syntax. The text that specifies the WSDL
and schema might specify restrictions that reflect actual protocol behavior. For example, the schema
definition might allow for an element to be empty, null, or not present but the behavior of the protocol
as specified restricts the same elements to being non-empty, not null, or present.

2.1 Transport

This protocol uses SOAP 1.1, as specified in [SOAP1.1].

The protocol MUST support SOAP over HTTP, as specified in [RFC2616]. The protocol SHOULD use
secure communications by means of HTTPS, as defined in [RFC2818].

2.2 Common Message Syntax

This section contains common definitions that are used by this protocol. The syntax of the definitions
uses XML schema, as defined in [XMLSCHEMA1] and [XMLSCHEMA2], and Web Services
Description Language (WSDL), as defined in [WSDL].

2.2.1 Namespaces

This specification defines and references various XML namespaces using the mechanisms specified in
[XMLNS]. Although this specification associates a specific XML namespace prefix for each XML
namespace that is used, the choice of any particular XML namespace prefix is implementation-specific
and not significant for interoperability.

Prefix Namespace URI Reference

soap http://schemas.xmlsoap.org/wsdl/soap/ [SOAP1.1]

t http://schemas.microsoft.com/exchange/services/2006/types

tns http://schemas.microsoft.com/exchange/services/2006/messages

wsdl http://schemas.xmlsoap.org/wsdl/ [WSDL]

wsi http://ws-i.org/schemas/conformanceClaim/ [WSIBASIC]

[XMLSCHEMA1/2]
xs http://www.w3.org/2001/XMLSchema
[XMLSCHEMA2/2]

2.2.2 Messages

This specification does not define any common WSDL message definitions.

2.2.3 Elements

This specification does not define any common XML schema element definitions.

9 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
2.2.4 Complex Types

This specification does not define any common XML schema complex type definitions.

2.2.5 Simple Types

This specification does not define any common XML schema simple type definitions.

2.2.6 Attributes

This specification does not define any common XML schema attribute definitions.

2.2.7 Groups

This specification does not define any common XML schema group definitions.

2.2.8 Attribute Groups

This specification does not define any common XML schema attribute group definitions.

10 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
3 Protocol Details
The client side of this protocol is simply a pass-through. That is, no additional timers or other state is
required on the client side of this protocol. Calls made by the higher-layer protocol or application are
passed directly to the transport, and the results returned by the transport are passed directly back to
the higher-layer protocol or application.

In the following sections, the schema definition might be less restrictive than the processing rules
imposed by the protocol. The WSDL in this specification matches the WSDL that shipped with the
product and provides a base description of the schema. The text that introduces the WSDL specifies
additional restrictions that reflect actual Microsoft product behavior. For example, the schema
definition might allow for an element to be empty, null, or not present but the behavior of the protocol
as specified restricts the same elements to being non-empty, not null and present.

3.1 ExchangeServicePortType Server Details

This protocol defines a single WSDL port type and two operations that set the lifecycle state of a site
mailbox and unpin a site mailbox from a client.

3.1.1 Abstract Data Model

None.

3.1.2 Timers

None.

3.1.3 Initialization

None.

3.1.4 Message Processing Events and Sequencing Rules

The following table summarizes the list of operations as defined by this specification.

Operation Description

SetTeamMailbox The SetTeamMailbox WSDL operation sets the lifecycle state of a site mailbox.

The UnpinTeamMailbox WSDL operation unpins the site mailbox from the client by
UnpinTeamMailbox
removing it from the Autodiscover response.

3.1.4.1 SetTeamMailbox

The SetTeamMailbox WSDL operation sets the lifecycle state of a site mailbox.

The following is the WSDL port type specification of the SetTeamMailbox WSDL operation.

<wsdl:operation name="SetTeamMailbox" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">

<wsdl:input message="tns:SetTeamMailboxSoapIn"/>
<wsdl:output message="tns:SetTeamMailboxSoapOut"/>
</wsdl:operation>

11 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
The following is the WSDL binding specification of the SetTeamMailbox WSDL operation.

<wsdl:operation name="SetTeamMailbox" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">

<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/SetTeamMailbox"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
<wsdl:input>
<soap:body use="literal" parts="request"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
<soap:header message="tns:SetTeamMailboxSoapIn" part="RequestVersion" use="literal"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
<soap:header message="tns:SetTeamMailboxSoapIn" part="ManagementRole" use="literal"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal" parts="SetTeamMailboxResult"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
<soap:header message="tns:SetTeamMailboxSoapOut" part="ServerVersion" use="literal"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
</wsdl:output>
</wsdl:operation>

The protocol client sends a SetTeamMailboxSoapIn request WSDL message and the protocol
server responds with a SetTeamMailboxSoapOut response WSDL message.

3.1.4.1.1 Messages

The following table summarizes the set of WSDL message definitions that are specific to this
operation.

Message Description

SetTeamMailboxSoapIn Specifies a request to set the lifecycle state of a site mailbox.

SetTeamMailboxSoapOut Specifies the response to a SetTeamMailboxSoapIn request WSDL message.

3.1.4.1.1.1 SetTeamMailboxSoapIn

The SetTeamMailboxSoapIn WSDL message specifies a request to set the lifecycle state of a site
mailbox.

The following is the SetTeamMailboxSoapIn WSDL message specification.

<wsdl:message name="SetTeamMailboxSoapIn" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">

<wsdl:part name="request" element="tns:SetTeamMailbox"/>
<wsdl:part name="RequestVersion" element="t:RequestServerVersion"/>
<wsdl:part name="ManagementRole" element="t:ManagementRole"/>
</wsdl:message>

The SetTeamMailboxSoapIn WSDL message is the input message for the SOAP action
http://schemas.microsoft.com/exchange/services/2006/messages/SetTeamMailbox.

The parts of the SetTeamMailboxSoapIn WSDL message are described in the following table.

Part name Element/type Description

request SetTeamMailbox Specifies the SOAP body of a request to set the lifecycle

12 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
 Part name Element/type Description

(section 3.1.4.1.2.1) state of a site mailbox.

RequestServerVersion Specifies a SOAP header that identifies the schema

RequestVersion ([MS-OXWSCDATA] section version for the SetTeamMailbox WSDL operation
2.2.3.9) request.

ManagementRole
Specifies a SOAP header that identifies a user or
ManagementRole ([MS-OXWSCDATA] section application role.
2.2.3.7)

3.1.4.1.1.2 SetTeamMailboxSoapOut

The SetTeamMailboxSoapOut WSDL message specifies the response to a

SetTeamMailboxSoapIn request WSDL message.

The following is the SetTeamMailboxSoapOut WSDL message specification.

<wsdl:message name="SetTeamMailboxSoapOut" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">

<wsdl:part name="SetTeamMailboxResult" element="tns:SetTeamMailboxResponse"/>
<wsdl:part name="ServerVersion" element="t:ServerVersionInfo"/>
</wsdl:message>

The SetTeamMailboxSoapOut WSDL message is the output message for the SOAP action
http://schemas.microsoft.com/exchange/services/2006/messages/SetTeamMailbox.

The parts of the SetTeamMailboxSoapOut WSDL message are described in the following table.

Part name Element/type Description

SetTeamMailboxResponse
SetTeamMailboxResult Specifies the SOAP body of the response.
(section 3.1.4.1.2.2)

ServerVersionInfo
Specifies a SOAP header that identifies the
ServerVersion ([MS-OXWSCDATA] section server version for the response.
2.2.3.10)

A successful SetTeamMailbox WSDL operation request returns a SetTeamMailboxResponse

element with the ResponseClass attribute ([MS-OXWSCDATA] section 2.2.4.67) set to "Success".
The ResponseCode element ([MS-OXWSCDATA] section 2.2.4.67) of the
SetTeamMailboxResponse element is set to "NoError".

If the SetTeamMailbox WSDL operation request is not successful, it returns a

SetTeamMailboxResponse element with the ResponseClass attribute ([MS-OXWSCDATA] section
2.2.4.67) set to "Error". The ResponseCode element ([MS-OXWSCDATA] section 2.2.4.67) of the
SetTeamMailboxResponse element is set to one of the common error codes defined in [MS-
OXWSCDATA] section 2.2.5.24.

3.1.4.1.2 Elements

The following table summarizes the XML schema element definitions that are specific to this
operation.

13 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
 Element Description

SetTeamMailbox The input data for the SetTeamMailbox WSDL operation.

SetTeamMailboxResponse The result data for the SetTeamMailbox WSDL operation.

3.1.4.1.2.1 SetTeamMailbox

The SetTeamMailbox element specifies the input data for the SetTeamMailbox WSDL operation.

<xs:element name="SetTeamMailbox" type="tns:SetTeamMailboxRequestType"

xmlns:xs="http://www.w3.org/2001/XMLSchema"/>

3.1.4.1.2.2 SetTeamMailboxResponse

The SetTeamMailboxResponse element specifies the result data for the SetTeamMailbox WSDL
operation.

<xs:element name="SetTeamMailboxResponse" type="tns:SetTeamMailboxResponseMessageType"

xmlns:xs="http://www.w3.org/2001/XMLSchema"/>

3.1.4.1.3 Complex Types

The following table summarizes the XML schema complex type definitions that are specific to this
operation.

Complex type Description

SetTeamMailboxRequestType Specifies the request for the SetTeamMailbox WSDL operation.

SetTeamMailboxResponseMessageType Specifies the response for the SetTeamMailbox WSDL operation.

3.1.4.1.3.1 SetTeamMailboxRequestType

Namespace: http://schemas.microsoft.com/exchange/services/2006/messages

The SetTeamMailboxRequestType complex type specifies the request for the SetTeamMailbox
WSDL operation. The SetTeamMailboxReqestType complex type extends the BaseRequestType
complex type, as specified in [MS-OXWSCDATA] section 2.2.4.17.

<xs:complexType name="SetTeamMailboxRequestType" xmlns:xs="http://www.w3.org/2001/XMLSchema">

<xs:complexContent mixed="false">
<xs:extension base="tns:BaseRequestType">
<xs:sequence>
<xs:element name="EmailAddress" type="t:EmailAddressType"/>
<xs:element name="SharePointSiteUrl" type="xs:string"/>
<xs:element name="State" type="t:TeamMailboxLifecycleStateType"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

14 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
EmailAddress: An element of type EmailAddressType, as defined in [MS-OXWSCDATA] section
2.2.4.31, that represents the email address of the site mailbox.

SharePointSiteUrl: An element of type string, as defined in [XMLSCHEMA2], that represents the

URL of the web-based collaboration environment that is linked to the site mailbox.

State: An element of type TeamMailboxLifecycleStateType (section 3.1.4.1.4.1) that represents

the target site mailbox lifecycle state to set.

3.1.4.1.3.2 SetTeamMailboxResponseMessageType

Namespace: http://schemas.microsoft.com/exchange/services/2006/messages

The SetTeamMailboxResponseMessageType complex type specifies the response for the

SetTeamMailbox WSDL operation. The SetTeamMailboxResponseMessageType complex type
extends the ResponseMessageType complex type, as described in [MS-OXWSCDATA] section
2.2.4.67.

<xs:complexType name="SetTeamMailboxResponseMessageType"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:ResponseMessageType"/>
</xs:complexContent>
</xs:complexType>

3.1.4.1.4 Simple Types

The following table summarizes the XML schema simple type definitions that are specific to this
operation.

Simple type Description

TeamMailboxLifecycleStateType Indicates the type of the site mailbox lifecycle state.

3.1.4.1.4.1 TeamMailboxLifecycleStateType

Namespace: http://schemas.microsoft.com/exchange/services/2006/types

The TeamMailboxLifecycleStateType simple type indicates the type of the site mailbox lifecycle
state.

<xs:simpleType name="TeamMailboxLifecycleStateType"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:restriction base="xs:string">
<xs:enumeration value="Active"/>
<xs:enumeration value="Closed"/>
<xs:enumeration value="Unlinked"/>
<xs:enumeration value="PendingDelete"/>
</xs:restriction>
</xs:simpleType>

The following table specifies the allowable values for the TeamMailboxLifecycleStateType simple
type.

15 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
 Value Meaning

Active A site mailbox is in active use.

Closed A site mailbox has been closed and is not in active use.

A site mailbox is not linked to a web-based collaboration environment. The "Active", "Closed",
Unlinked and "PendingDelete" values are mutually exclusive, but the "Unlinked" value is not mutually
exclusive of the other values.

A site mailbox is pending deletion. A site mailbox has to be closed first before it can be set as
PendingDelete
"PendingDelete".

3.1.4.1.5 Attributes

None.

3.1.4.1.6 Groups

None.

3.1.4.1.7 Attribute Groups

None.

3.1.4.2 UnpinTeamMailbox

The UnpinTeamMailbox WSDL operation unpins the site mailbox from the client by removing it
from the Autodiscover response.

The following is the WSDL port type specification of the UnpinTeamMailbox WSDL operation.

<wsdl:operation name="UnpinTeamMailbox" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">

<wsdl:input message="tns:UnpinTeamMailboxSoapIn"/>
<wsdl:output message="tns:UnpinTeamMailboxSoapOut"/>
</wsdl:operation>

The following is the WSDL binding specification of the UnpinTeamMailbox operation.

<wsdl:operation name="UnpinTeamMailbox" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">

<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/UnpinTeamMailbox"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
<wsdl:input>
<soap:body use="literal" parts="request"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
<soap:header message="tns:UnpinTeamMailboxSoapIn" part="RequestVersion" use="literal"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal" parts="UnpinTeamMailboxResult"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
<soap:header message="tns:UnpinTeamMailboxSoapOut" part="ServerVersion" use="literal"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"/>
</wsdl:output>
</wsdl:operation>

16 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
The protocol client sends an UnpinTeamMailboxSoapIn request WSDL message and the protocol
server responds with an UnpinTeamMailboxSoapOut response WSDL message.

3.1.4.2.1 Messages

The following table summarizes the set of WSDL message definitions that are specific to this
operation.

Message Description

UnpinTeamMailboxSoapIn Specifies a request to unpin a site mailbox.

Specifies the response to the UnpinTeamMailboxSoapIn request WSDL

UnpinTeamMailboxSoapOut
message.

3.1.4.2.1.1 UnpinTeamMailboxSoapIn

The UnpinTeamMailboxSoapIn WSDL message specifies a request to unpin a site mailbox.

The following is the UnpinTeamMailboxSoapIn WSDL message specification.

<wsdl:message name="UnpinTeamMailboxSoapIn" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">

<wsdl:part name="request" element="tns:UnpinTeamMailbox"/>
<wsdl:part name="RequestVersion" element="t:RequestServerVersion"/>
</wsdl:message>

The UnpinTeamMailboxSoapIn WSDL message is the input message for the SOAP action
http://schemas.microsoft.com/exchange/services/2006/messages/UnpinTeamMailbox.

The parts of the UnpinTeamMailboxSoapIn WSDL message are described in the following table.

Part name Element/type Description

UnpinTeamMailbox
request Specifies the SOAP body of a request to unpin the mailbox.
(section 3.1.4.2.2.1)

RequestServerVersion
Specifies a SOAP header that identifies the schema version
RequestVersion ([MS-OXWSCDATA] section for the UnpinTeamMailbox WSDL operation request.
2.2.3.9)

3.1.4.2.1.2 UnpinTeamMailboxSoapOut

The UnpinTeamMailboxSoapOut WSDL message specifies the response to an

UnpinTeamMailboxSoapIn request WSDL message.

The following is the UnpinTeamMailboxSoapOut WSDL message specification.

<wsdl:message name="UnpinTeamMailboxSoapOut" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">

<wsdl:part name="UnpinTeamMailboxResult" element="tns:UnpinTeamMailboxResponse"/>
<wsdl:part name="ServerVersion" element="t:ServerVersionInfo"/>
</wsdl:message>

17 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
The UnpinTeamMailboxSoapOut WSDL message is the output message for the SOAP action
http://schemas.microsoft.com/exchange/services/2006/messages/UnpinTeamMailbox.

The parts of the UnpinTeamMailboxSoapOut WSDL message are described in the following table.

Part name Element/type Description

UnpinTeamMailboxResponse
UnpinTeamMailboxResult Specifies the SOAP body of the response.
(section 3.1.4.2.2.2)

ServerVersionInfo
Specifies a SOAP header that identifies the
ServerVersion ([MS-OXWSCDATA] section server version for the response.
2.2.3.10)

A successful UnpinTeamMailbox WSDL operation request returns an

UnpinTeamMailboxResponse element with the ResponseClass attribute ([MS-OXWSCDATA]
section 2.2.4.67) set to "Success". The ResponseCode element ([MS-OXWSCDATA] section 2.2.4.67)
of the UnpinTeamMailboxResponse element is set to "NoError".

If the UnpinTeamMailbox WSDL operation request is not successful, it returns an

UnpinTeamMailboxResponse element with the ResponseClass attribute ([MS-OXWSCDATA]
section 2.2.4.67) set to "Error". The ResponseCode element ([MS-OXWSCDATA] section 2.2.4.67) of
the UnpinTeamMailboxResponse element is set to one of the common errors defined in [MS-
OXWSCDATA] section 2.2.5.24.

3.1.4.2.2 Elements

The following table summarizes the XML schema element definitions that are specific to this
operation.

Element Description

UnpinTeamMailbox The input data for the UnpinTeamMailbox WSDL operation.

UnpinTeamMailboxResponse The result data for the UnpinTeamMailbox WSDL operation.

3.1.4.2.2.1 UnpinTeamMailbox

The UnpinTeamMailbox element specifies the input data for the UnpinTeamMailbox WSDL
operation.

<xs:element name="UnpinTeamMailbox" type="tns:UnpinTeamMailboxRequestType"

xmlns:xs="http://www.w3.org/2001/XMLSchema"/>

3.1.4.2.2.2 UnpinTeamMailboxResponse

The UnpinTeamMailboxResponse element specifies the result data for the UnpinTeamMailbox
WSDL operation.

<xs:element name="UnpinTeamMailboxResponse" type="tns:UnpinTeamMailboxResponseMessageType"

xmlns:xs="http://www.w3.org/2001/XMLSchema"/>

18 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
3.1.4.2.3 Complex Types

The following table summarizes the XML schema complex type definitions that are specific to this
operation.

Complex type Description

Specifies a request for the UnpinTeamMailbox WSDL

UnpinTeamMailboxRequestType
operation.

Specifies the response for the UnpinTeamMailbox WSDL

UnpinTeamMailboxResponseMessageType
operation.

3.1.4.2.3.1 UnpinTeamMailboxRequestType

Namespace: http://schemas.microsoft.com/exchange/services/2006/messages

The UnpinTeamMailboxRequestType complex type specifies a request for the UnpinTeamMailbox

WSDL operation. The UnPinTeamMailboxRequestType complex type extends the
BaseRequestType complex type, as specified in [MS-OXWSCDATA] section 2.2.4.17.

<xs:complexType name="UnpinTeamMailboxRequestType"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:BaseRequestType">
<xs:sequence>
<xs:element name="EmailAddress" type="t:EmailAddressType"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>

EmailAddress: An element of type EmailAddressType, as defined in [MS-OXWSCDATA] section

2.2.4.31, that represents the email address of the site mailbox.

3.1.4.2.3.2 UnpinTeamMailboxResponseMessageType

Namespace: http://schemas.microsoft.com/exchange/services/2006/messages

The UnpinTeamMailboxResponseMessageType specifies the response for an UnpinTeamMailbox

WSDL operation. The UnpinTeamMailboxResponseMessageType complex type extends the
ResponseMessageType complex type, as specified in [MS-OXWSCDATA] section 2.2.4.67.

<xs:complexType name="UnpinTeamMailboxResponseMessageType"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:complexContent mixed="false">
<xs:extension base="tns:ResponseMessageType"/>
</xs:complexContent>
</xs:complexType>

3.1.4.2.4 Simple Types

None.

3.1.4.2.5 Attributes

None.

19 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
3.1.4.2.6 Groups

None.

3.1.4.2.7 Attribute Groups

None.

3.1.5 Timer Events

None.

3.1.6 Other Local Events

None.

20 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
4 Protocol Examples
In the following example, a site mailbox is successfully unpinned from the client.

Request:

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<RequestServerVersion Version="Exchange2013"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types" />
</soap:Header>
<soap:Body>
<UnpinTeamMailbox xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<EmailAddress>
<EmailAddress xmlns="http://schemas.microsoft.com/exchange/services/2006/types">SM-
[email protected]</EmailAddress>
</EmailAddress>
</UnpinTeamMailbox>
</soap:Body>
</soap:Envelope>

Response:

<?xml version="1.0" encoding="utf-8"?>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<h:ServerVersionInfo MajorVersion="15" MinorVersion="0" MajorBuildNumber="913"
MinorBuildNumber="0" Version="Exchange2013"
xmlns:h="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns="http://schemas.microsoft.com/exchange/services/2006/types"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance"/>
</s:Header>
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<UnpinTeamMailboxResponse ResponseClass="Success"
xmlns="http://schemas.microsoft.com/exchange/services/2006/messages">
<ResponseCode>NoError</ResponseCode>
</UnpinTeamMailboxResponse>
</s:Body>
</s:Envelope>

21 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
5 Security

5.1 Security Considerations for Implementers

None.

5.2 Index of Security Parameters

None.

22 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
6 Appendix A: Full WSDL
For ease of implementation, the full WSDL is provided in this appendix.

<?xml version="1.0" encoding="UTF-8"?>

<wsdl:definitions xmlns:tns="http://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
targetNamespace="http://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
<wsdl:types>
<xs:schema elementFormDefault="qualified"
targetNamespace="http://schemas.microsoft.com/exchange/services/2006/messages"
version="Exchange2016" id="messages" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="MS-OXWSSMBX-messages.xsd"/>
</xs:schema>
</wsdl:types>
<wsdl:portType name="ExchangeServicePortType">
<wsdl:operation name="UnpinTeamMailbox">
<wsdl:input message="tns:UnpinTeamMailboxSoapIn"/>
<wsdl:output message="tns:UnpinTeamMailboxSoapOut"/>
</wsdl:operation>
<wsdl:operation name="SetTeamMailbox">
<wsdl:input message="tns:SetTeamMailboxSoapIn"/>
<wsdl:output message="tns:SetTeamMailboxSoapOut"/>
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="ExchangeServiceBinding" type="tns:ExchangeServicePortType">
<wsdl:documentation>
<wsi:Claim conformsTo="http://ws-i.org/profiles/basic/1.0" xmlns:wsi="http://ws-
i.org/schemas/conformanceClaim/"/>
</wsdl:documentation>
<soap:binding transport="http://schemas.xmlsoap.org/soap/http"/>
<wsdl:operation name="UnpinTeamMailbox">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/UnpinTeamMailbox"/>
<wsdl:input>
<soap:body use="literal" parts="request"/>
<soap:header message="tns:UnpinTeamMailboxSoapIn" part="RequestVersion"
use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal" parts="UnpinTeamMailboxResult"/>
<soap:header message="tns:UnpinTeamMailboxSoapOut" part="ServerVersion"
use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="SetTeamMailbox">
<soap:operation
soapAction="http://schemas.microsoft.com/exchange/services/2006/messages/SetTeamMailbox"/>
<wsdl:input>
<soap:body use="literal" parts="request"/>
<soap:header message="tns:SetTeamMailboxSoapIn" part="RequestVersion" use="literal"/>
<soap:header message="tns:SetTeamMailboxSoapIn" part="ManagementRole" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal" parts="SetTeamMailboxResult"/>
<soap:header message="tns:SetTeamMailboxSoapOut" part="ServerVersion" use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:message name="SetTeamMailboxSoapIn">
<wsdl:part name="request" element="tns:SetTeamMailbox"/>
<wsdl:part name="RequestVersion" element="t:RequestServerVersion"/>
<wsdl:part name="ManagementRole" element="t:ManagementRole"/>
</wsdl:message>
<wsdl:message name="SetTeamMailboxSoapOut">

23 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
 <wsdl:part name="SetTeamMailboxResult" element="tns:SetTeamMailboxResponse"/>
<wsdl:part name="ServerVersion" element="t:ServerVersionInfo"/>
</wsdl:message>
<wsdl:message name="UnpinTeamMailboxSoapIn">
<wsdl:part name="request" element="tns:UnpinTeamMailbox"/>
<wsdl:part name="RequestVersion" element="t:RequestServerVersion"/>
</wsdl:message>
<wsdl:message name="UnpinTeamMailboxSoapOut">
<wsdl:part name="UnpinTeamMailboxResult" element="tns:UnpinTeamMailboxResponse"/>
<wsdl:part name="ServerVersion" element="t:ServerVersionInfo"/>
</wsdl:message>
</wsdl:definitions>

24 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
7 Appendix B: Full XML Schema
Schema name Prefix Section

http://schemas.microsoft.com/exchange/services/2006/types t 7.2

http://schemas.microsoft.com/exchange/services/2006/messages tns 7.1

For ease of implementation, the following sections provide the full XML schema for this protocol.

7.1 http://schemas.microsoft.com/exchange/services/2006/messages Schema

This section contains the contents of the MS-OXWSSMBX-messages.xsd file and information about
additional files that this schema file requires to operate correctly.

MS-OXWSSMBX-messages.xsd includes the files listed in the following table. For the schema file to
operate correctly, these files have to be in the folder that contains the WSDL, types schema, and
messages schema files for this protocol.

File name Defining specification

MS-OXWSCDATA-messages.xsd [MS-OXWSCDATA] section 7.1

MS-OXWSCDATA-types.xsd [MS-OXWSCDATA] section 7.2

MS-OXWSSMBX-types.xsd section 7.2

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:tns="http://schemas.microsoft.com/exchange/services/2006/messages"
xmlns:t="http://schemas.microsoft.com/exchange/services/2006/types"
elementFormDefault="qualified"
targetNamespace="http://schemas.microsoft.com/exchange/services/2006/messages"
version="Exchange2016" id="messages" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="MS-OXWSCDATA-messages.xsd"/>
<xs:import schemaLocation="MS-OXWSCDATA-types.xsd"
namespace="http://schemas.microsoft.com/exchange/services/2006/types"/>
<xs:import schemaLocation="MS-OXWSSMBX-types.xsd"
namespace="http://schemas.microsoft.com/exchange/services/2006/types"/>
<xs:complexType name="SetTeamMailboxRequestType">
<xs:complexContent mixed="false">
<xs:extension base="tns:BaseRequestType">
<xs:sequence>
<xs:element name="EmailAddress" type="t:EmailAddressType"/>
<xs:element name="SharePointSiteUrl" type="xs:string"/>
<xs:element name="State" type="t:TeamMailboxLifecycleStateType"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="SetTeamMailbox" type="tns:SetTeamMailboxRequestType"/>
<xs:complexType name="SetTeamMailboxResponseMessageType">
<xs:complexContent mixed="false">
<xs:extension base="tns:ResponseMessageType"/>
</xs:complexContent>
</xs:complexType>
<xs:element name="SetTeamMailboxResponse" type="tns:SetTeamMailboxResponseMessageType"/>
<xs:complexType name="UnpinTeamMailboxRequestType">
<xs:complexContent mixed="false">
<xs:extension base="tns:BaseRequestType">

25 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
 <xs:sequence>
<xs:element name="EmailAddress" type="t:EmailAddressType"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="UnpinTeamMailbox" type="tns:UnpinTeamMailboxRequestType"/>
<xs:complexType name="UnpinTeamMailboxResponseMessageType">
<xs:complexContent mixed="false">
<xs:extension base="tns:ResponseMessageType"/>
</xs:complexContent>
</xs:complexType>
<xs:element name="UnpinTeamMailboxResponse"
type="tns:UnpinTeamMailboxResponseMessageType"/>
</xs:schema>

7.2 http://schemas.microsoft.com/exchange/services/2006/types Schema

This section contains the contents of the MS-OXWSSMBX-types.xsd file.

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema elementFormDefault="qualified"
targetNamespace="http://schemas.microsoft.com/exchange/services/2006/types"
version="Exchange2016" id="types" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="http://www.w3.org/XML/1998/namespace"/>
<xs:simpleType name="TeamMailboxLifecycleStateType">
<xs:restriction base="xs:string">
<xs:enumeration value="Active"/>
<xs:enumeration value="Closed"/>
<xs:enumeration value="Unlinked"/>
<xs:enumeration value="PendingDelete"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>

26 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
8 Appendix C: Product Behavior
The information in this specification is applicable to the following Microsoft products or supplemental
software. References to product versions include updates to those products.

 Microsoft Exchange Server 2013

 Microsoft Exchange Server 2016

 Microsoft Outlook 2013

 Microsoft Outlook 2016

 Microsoft SharePoint Server 2013

 Microsoft SharePoint Server 2016

 Microsoft Exchange Server 2019

 Microsoft Outlook 2019

Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base
(KB) number appears with a product name, the behavior changed in that update. The new behavior
also applies to subsequent updates unless otherwise specified. If a product edition appears with the
product version, behavior is different in that product edition.

Unless otherwise specified, any statement of optional behavior in this specification that is prescribed
using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the
SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the
product does not follow the prescription.

27 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
9 Change Tracking
This section identifies changes that were made to this document since the last release. Changes are
classified as Major, Minor, or None.

The revision class Major means that the technical content in the document was significantly revised.
Major changes affect protocol interoperability or implementation. Examples of major changes are:

 A document revision that incorporates changes to interoperability requirements.

 A document revision that captures changes to protocol functionality.

The revision class Minor means that the meaning of the technical content was clarified. Minor changes
do not affect protocol interoperability or implementation. Examples of minor changes are updates to
clarify ambiguity at the sentence, paragraph, or table level.

The revision class None means that no new technical changes were introduced. Minor editorial and
formatting changes may have been made, but the relevant technical content is identical to the last
released version.

The changes made to this document are listed in the following table. For more information, please
contact [email protected].

Section Description Revision class

8 Appendix C: Product Behavior Updated list of supported products. Major

28 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
10 Index
A
Message processing
Abstract data model server 11
server 11 Messages
Applicability 8 attribute groups 10
Attribute groups 10 attributes 10
Attributes 10 complex types 10
elements 9
C enumerated 9
groups 10
Capability negotiation 8 namespaces 9
Change tracking 28 simple types 10
Client syntax 9
overview 11 transport 9
Complex types 10
N
D
Namespaces 9
Data model - abstract Normative references 6
server 11
O
E
Operations
Events SetTeamMailbox 11
local - server 20 UnpinTeamMailbox 16
timer - server 20 Overview (synopsis) 7
Examples 21
P
F
Parameters - security index 22
Fields - vendor-extensible 8 Preconditions 8
Full WSDL 23 Prerequisites 8
Full XML schema 25 Product behavior 27
Protocol Details
http://schemas.microsoft.com/exchange/service overview 11
s/2006/messages Schema 25
R
http://schemas.microsoft.com/exchange/service
s/2006/types Schema 26 References 6
informative 7
G normative 6
Relationship to
Glossary 5 other protocols
Groups 10 Relationship to
other algorithms 7
I Relationship to other protocols 7

Implementer - security considerations 22 S

Index of security parameters 22
Informative references 7 Security
Initialization implementer considerations 22
server 11 parameter index 22
Introduction 5 Sequencing rules
server 11
L Server
abstract data model 11
Local events initialization 11
server 20 local events 20
message processing 11
overview 11
M
sequencing rules 11

29 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018
 SetTeamMailbox operation 11
timer events 20
timers 11
UnpinTeamMailbox operation 16
Simple types 10
Standards assignments 8
Syntax
messages - overview 9

Timer events
server 20
Timers
server 11
Tracking changes 28
Transport 9
Types
complex 10
simple 10

Vendor-extensible fields 8
Versioning 8

WSDL 23

XML schema 25

http://schemas.microsoft.com/exchange/service
s/2006/messages Schema 25

http://schemas.microsoft.com/exchange/service
s/2006/types Schema 26

30 / 30
[MS-OXWSSMBX] - v20181001
Site Mailbox Web Service Protocol
Copyright © 2018 Microsoft Corporation
Release: October 1, 2018