element <copyMessageRequest> (global)
Namespace:
http://schemas.microsoft.com/hs/2001/10/myInbox
Type:
anonymous complexType
Content:
complex, 1 attribute, 2 elements
Defined:
globally in myInbox.xsd; see XML source
Includes:
definitions of 1 attribute, 2 elements
Used:
never
XML Representation Summary
<copyMessageRequest
   
 = 
xsd:boolean
   
>
   
Content: 
</copyMessageRequest>
Content model elements (2):
message (in copyMessageRequest), targetFolder (in copyMessageRequest)
Annotation
This message allows clients to copy one or more messages to a folder. The message data (including attachments) is copied and new message messages are returned with unique message ID values. This element encapsulates the arguments to the copyMessage method. It must contain a message element and a targetFolder element.
XML Source (see within schema source)
<xsd:element name="copyMessageRequest">
<xsd:annotation>
<xsd:documentation>
This message allows clients to copy one or more messages to a folder. The message data
(including attachments) is copied and new message messages are returned with unique message
ID values.

This element encapsulates the arguments to the copyMessage method. It must contain a
message element and a targetFolder element.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="unbounded" minOccurs="1" name="message">
<xsd:annotation>
<xsd:documentation>
This element contains a select statement that contains an XPATH expression
indicating a message message for which to copy the associated message.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="select" type="hs:selectType" use="required">
<xsd:annotation>
<xsd:documentation>
The location of the message (which is associated with the message) to copy.
For example, /myInbox/message[@id=""].
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="copyAsDraft" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If this value is present and set to true, the message is copied as a draft into the target folder
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="clientId" type="hs:uuidType" use="optional">
<xsd:annotation>
<xsd:documentation>
This attribute specifies that the server should use the value of this attribute as the id of the new message.
useClientIds should be present on the copyRequest element and set to true
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
<xsd:element name="targetFolder" type="refType">
<xsd:annotation>
<xsd:documentation>
Contains the id of an existing folder to copy the message(s) to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
<xsd:attribute name="useClientIds" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If this optional attribute is present, each message elements id attribute will be used as the new id
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
Attribute Detail (all declarations; 1/1)
useClientIds
Type:
xsd:boolean, predefined
Use:
optional
Defined:
locally within (this) copyMessageRequest element
If this optional attribute is present, each message elements id attribute will be used as the new id
XML Source (see within schema source)
<xsd:attribute name="useClientIds" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If this optional attribute is present, each message elements id attribute will be used as the new id
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
Content Element Detail (all declarations; 2/2)
message
Type:
anonymous complexType, empty content
Defined:
locally within (this) copyMessageRequest element
This element contains a select statement that contains an XPATH expression indicating a message message for which to copy the associated message.
XML Source (see within schema source)
<xsd:element maxOccurs="unbounded" minOccurs="1" name="message">
<xsd:annotation>
<xsd:documentation>
This element contains a select statement that contains an XPATH expression
indicating a message message for which to copy the associated message.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="select" type="hs:selectType" use="required">
<xsd:annotation>
<xsd:documentation>
The location of the message (which is associated with the message) to copy.
For example, /myInbox/message[@id=""].
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="copyAsDraft" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
If this value is present and set to true, the message is copied as a draft into the target folder
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="clientId" type="hs:uuidType" use="optional">
<xsd:annotation>
<xsd:documentation>
This attribute specifies that the server should use the value of this attribute as the id of the new message.
useClientIds should be present on the copyRequest element and set to true
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:element>
targetFolder
Type:
refType, empty content
Defined:
locally within (this) copyMessageRequest element
Contains the id of an existing folder to copy the message(s) to.
XML Source (see within schema source)
<xsd:element name="targetFolder" type="refType">
<xsd:annotation>
<xsd:documentation>
Contains the id of an existing folder to copy the message(s) to.
</xsd:documentation>
</xsd:annotation>
</xsd:element>