Put Method

Description

Set message attributes.

Syntax

Visual Basic
Public Sub Put( _ ByVal Value As String, _ Optional ByVal Part As PutConstants = imapPutFlagsAdd, _ Optional ByVal MsgSet As String _ )

Visual Basic

Public Sub Put( _
   ByVal Value As String, _
   Optional ByVal Part As PutConstants = imapPutFlagsAdd, _
   Optional ByVal MsgSet As String _
)

Parameters

Value

Specifies the value to set for the Part.

Part

Value	Description
imapPutFlags	Replaces the flags for each message in the MsgSet.
imapPutFlagsAdd	Adds flags for each message in the MsgSet.
imapPutFlagsRemove	Removes flags for each message in the MsgSet.

Specifies the message part to be set. The default value is imapPutFlagsAdd.

MsgSet

Specifies the message numbers to set. The default is all messages.

Remarks

This method makes it easy to alter parts of a message or messages on the server. According to RFC 2060, you can only set the flags message part.

If provided, MsgSet specifies one or more message numbers in the range from 1 to Count. Each number should be separated with a comma. A range of numbers may be indicated with a lower and upper number separated with a colon. For example, a message set of "1, 5:7, 12" will retrieve 5 messages: 1, 5, 6, 7, and 12.

See RFC 2060 for a list of predefined flags that can be set for a message. Other server implementations may have additional flags that can be set.

Error Codes

This method may generate the following error code (refer to MailErrorConstants for a complete list of error codes):

ptBlocked
ptConnectionAborted
ptConnectionReset
ptNetworkDown
ptNetworkReset
ptNoBufferSpace
ptNotConnected
ptProtocol
ptTimeout