forwardRequest

Forwards an existing item to other users.

Request

<forwardRequest>
   <id type="types:uid"/>
   <view type="string"/>
   <embed type="boolean"/>
</forwardRequest>

Response

<forwardResponse>
   <item type="types:Item"/>
   <status type="types:Status"/>
</forwardResponse>

Elements

id

Specifies the ID of the item you want to forward.

view

Specifies if you want the original message body returned in the forward method. If you do, supply “message” or “message/RTF” in the view.

embed

Specifies if the original item is to be sent as an attachment in the new mail item. If you do, pass True in the embed element in the forwardRequest. Otherwise, pass False.

If you set embed to true, you need to make sure the view on forwardRequest does not contain the "attachments" keyword. The forwardResponse will then send down an attachment structure that needs to be added to the new item.

item

Specifies a returned item that can be modified and passed to the sendRequest method to complete the forwardRequest.

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.

Remarks

Forwarding a message is a two-step process.

The first step is to call forwardRequest with the ID of the item that you want to forward. A new mail item is then returned with the original subject and other fields defined in the view. You can modify this returned item. For example, the caller might want to prepend “Fwd:” to the beginning of the subject. The message body and other fields can also be modified and attachments added. The linkInfo element is returned with this item.

The second step is to call sendRequest with the modified mail item. The linkInfo element needs to be passed unchanged in the sendRequest. The linkInfo element is necessary for the POA to link the original item with the new item using the sendRequest.

Example

<forwardRequest>
<id>44FEDD14.domain1.po1.100.16E3837.1.FB2.1@4:7.domain1.po1.100.0.1.0.1@16</id> 
<view>subject id message</view> 
<embed>false</embed> 
</forwardRequest>

<forwardResponse> 
<item> 
<source>sent</source> 
<subject>New Appt 1</subject> 
<message> 
<part contentType="text/plain" length="64">YXNkZgogCiAKVXNlciAxCiAgTm92ZWxsIEluYy4gIAogICA4NjEtMTEzMCAgIAo=</part> 
</message> 
<attachments> 
<attachment> 
<id itemReference="1">4018</id> 
<name>FILE</name> 
<contentType>Appointment</contentType> 
<hidden>1</hidden> 
</attachment> 
</attachments> 
<link> 
<id>0:4018</id> 
<type>forward</type> 
</link> 
</item> 
<status> 
<code>0</code> 
</status> 
</forwardResponse>