mail

Description

Emails the entity with the additional information posted.

URL

/qcbin/rest/domains/{domain}/projects/{project}/{entity collection}/{ID}/mail

Remarks

Post the mail data in an XML compliant with the mail Schema. For example:

<mail>
    <to-recipients>alex_qa, EdmundBertram@MansfieldPark.uk</to-recipients>
    <subject>Problem assigned to you.</subject>
    <comment><![CDATA[Dear Edmund,<br /> Fanny Price not getting
       <i>exercise</i> because horse unavailable.]]></comment>
    <include-attributes>
        <attribute name="history" value="true" />
        <attribute name="attachments" value="true" />
    </include-attributes>
</mail>

To check whether a given entity supports mailing, check the SupportsMailing element of the entity-resource-descriptor returned by customization/entities/{entity name}.

HTTP Methods

GET: N/A

PUT: N/A

DELETE: N/A

POST: Sends an email

Media Type	GET	PUT	DELETE	POST
application/xml	-	-	-
application/json	-	-	-

Returns

One of the HTTP Return Codes.