MessageAttachment Complex Type
The MessageAttachment type provides a way of attaching a file to the message. Attachments may be embedded directly using Base64 encoding. Alternatively, they can be included by reference, using the URI identifying a file accessible on the web services server system. This type is used both for attaching a voice memo and other types of files.
Syntax
<MessageAttachment>
<DisplayName />
<Type />
<Size />
<Content />
<AttachmentFileURI />
</MessageAttachment>
Complex Type Elements
Element | Data type | Explanation |
---|---|---|
DisplayName |
|
The name of the attachment as displayed to the user. Usually this is the original file name of the attachment. If you specify the contents of the attachment in the Content element, DisplayName determines the file name and extension. |
Type |
Indicates whether the attachment is audio data or non-audio data:
|
|
Size |
|
Size of the Base64-encoded attachment body, in bytes. Size is not used if the attachment is made by reference. The usage of this element depends on the context:
|
Content |
|
The contents of the attachment using Base64 encoding. When reading messages, the body of the attachment is always provided in Content. Content is optional. The usage of this element depends on the context:
|
AttachmentFileURI |
|
A URI reference that specifies the contents of the attachment and the file extension of the attachment. AttachmentFileURI is optional. The usage of this element depends on the context:
|
Remarks
In calls to Read or ReadMessage, the operation returns the contents of an attachment in the Content element. In calls to Create, CreateForward, or CreateReply, you can specify the contents of an attachment in either the Content or AttachmentFileURI element.
Note
When making a remote Web Service call to a Groove Data Bridge, if you specify AttachmentFileURI, the URI is evaluated on the Groove Data Bridge system, not on the local system running the Web Services client application.