Topic Path: Pending > TIdIMAP4.UIDRetrieveNoDecodeToStream@String@TStream
ContentsIndexHome
PreviousUpNext
TIdIMAP4.UIDRetrieveNoDecodeToStream@String@TStream

Retrieves the raw encoded contents of a message and stores the contents in a stream.

Parameters 
Description 
AMsgUID 
Unique identifier for the message to retrieve.
 
AStream 
Stream used to store the message contents. 

Boolean - True on success.

UIDRetrieveNoDecodeToStream is a Boolean function used to retrieve the raw encoded contents of the unique message identifier indicated in AMsgUID, and to store the message contents in the stream indicated by AStream. 

UIDRetrieveNoDecodeToStream can be used to access the contents of the message without creating object instances in the MessageParts collection. 

UIDRetrieveNoDecodeToStream validates the message identifier in AMsgUID to ensure that it contains a valid value, and raises an EIdNumberInvalid exception if the requirement is not met. 

UIDRetrieveNoDecodeToStream requires that ConnectionState contain the value csSelected, or an EIdConnectionStateError exception will be raised. Use SelectMailBox or ExamineMailBox to select a mailbox prior to calling UIDRetrieveNoDecodeToStream. 

UIDRetrieveNoDecodeToStream creates a TIdMessage instance used to temporarily store the encoded contents of the specified message. The TIdMessage instance is freed after storing the message contents in the indicated stream. 

UIDRetrieveNoDecodeToStream returns True on successful completion of message retrieval. UIDRetrieveNoDecodeToStream returns False if a protocol error response is received during retrieval of the specified message. 

Use UIDRetrieveNoDecodeToFile to retrieve a message without decoding, and to store the contents in a file.

ConnectionState UIDRetrieveNoDecodeToFile EIdNumberInvalid EIdConnectionStateError TIdMessage.NoDecode

Copyright 1993-2006, Chad Z. Hower (aka Kudzu) and the Indy Pit Crew. All rights reserved.
Post feedback to the Indy Docs Newsgroup.