getAttachmentRequest

Returns the selected file attachment. It does not read embedded GroupWise items such as mail messages or appointments.

Request

<getAttachmentRequest>
   <id type="types:uid"/>
   <offset type="int"/>
   <length type="int"/>
   <flags type="types:AttachmentFlags"/>
</getAttachmentRequest>

Response

<getAttachmentResponse>
   <part type="types:MessagePart"/>
   <status type="types:Status"/>
</getAttachmentResponse>

Elements

id

Specifies the ID of the attachment to read.

offset

Specifies the starting position for reading the attachment.

length

Specifies the number of bytes to read from the offset.

part

Specifies the attachment.

code

Returns the error number related to the event. 0 indicates that the request was successful.

status

Returns the success or failure of the method.

flags

Specifies the attachment flags.

Remarks

To retrieve the entire file in one read, specify an offset of 0 with a length of -1. If you have a large file, you can read the attachment in chunks by using the offset element to position the attachment reader and specifying the length of the chunk’s size.

Example

<getAttachmentRequest> 
   <id>45003893.domain1.po1.200.20000CB.1.1530.1@45:45003893.
        domain1.po1.100.16E3837.1.FBA.1@1:7.
        domain1.po1.100.0.1.0.1@16</id> 
   <offset>0</offset> 
   <length>-1</length> 
</getAttachmentRequest>

<getAttachmentResponse> 
   <part length="164"offset="122">
       MS4gIFNhdmUgT09PIGFzIHRleHQgZmlsZXMgbmV4dCB0aW1lLg0KMi4gIEl
       uY2x1ZGUgdGhlIEJlZXAgY2xpZW50DQozLiAgRGlzY3VzcyB2ZXJzaW9uaW5
       nLg0KNC4gIE5ldEJlYW5zIDUuMCBCZXRhIDINCjUuICA=</part> 
   <status> 
      <code>0</code> 
   </status> 
</getAttachmentResponse>