TIdMessage = class(TIdBaseComponent)

• RFC 822 - Standard for the Format of ARPA Internet Text Messages (http://www.rfc-editor.org/rfc/rfc822.txt)

• RFC 1036 - Standard for Interchange of USENET Messages (http://www.rfc-editor.org/rfc/rfc1036.txt)

TIdMessage is used with message-based protocols, such as POP3, SMTP, and NNTP. TIdMessage supports Multipurpose Internet Mail Extensions (MIME) as described in the Internet Standards documents:

• RFC 2045 - Multipurpose Internet Mail Extensions (MIME), Part One: Format of Internet Message Bodies (http://www.rfc-editor.org/rfc/rfc2045.txt)

• RFC 2046 - Multipurpose Internet Mail Extensions (MIME), Part Two: Media Types (http://www.rfc-editor.org/rfc/rfc2046.txt)

• RFC 2047 - Multipurpose Internet Mail Extensions (MIME), Part Three: Message Header Extensions for Non-ASCII Text (http://www.rfc-editor.org/rfc/rfc2047.txt)

• RFC 2048 - Multipurpose Internet Mail Extensions (MIME), Part Four: Registration Procedures (http://www.rfc-editor.org/rfc/rfc2048.txt)

• RFC 2049 - Multipurpose Internet Mail Extensions (MIME), Part Five: Conformance Criteria and Examples (http://www.rfc-editor.org/rfc/rfc2049.txt)

property AttachmentEncoding: string;

property BccList: TIdEmailAddressList;

Use CCList to indicate message recipients that may appear in the "To:" headers for the message.

property Body: TStrings;

When IsEncoded is True, Body contains values that are encoded using the encoding scheme identified in ContentTransferEncoding. When IsEncoded is False, Body contains ASCII text that represents the contents of the message.

When ContentType contains a value in the "multipart/*" MIME family, use MessageParts to access the TIdText or TIdAttachment instances that make up the message.

property CCList: TIdEmailAddressList;

property CharSet: string;

• US-ASCII

• ISO-8859-1

• ISO-8859-2

• ISO-8859-3

• ISO-8859-4

• ISO-8859-5

• ISO-8859-6

• ISO-8859-7

• ISO-8859-8

• ISO-8859-9

• ISO-8859-10

All of these character sets are used as pure 7bit or 8bit sets without any shift or escape functions. The meaning of shift and escape sequences in these character sets is not defined. The "charset" parameter has been defined primarily for the purpose of textual data, and is described in this section for that reason. However, it is possible that non-textual data might also specify a charset value for some purpose.

property ContentDisposition: string;

ContentDisposition can contain the value "inline" for an Internet Message where the body part should be display immediately, and in the order in which it occurs.

ContentDisposition can contain the value "attachment" followed by additional parameters to indicate that the message part is separate from the main body of the message. The parameter "filename" can be used to suggest a filename where the message part is detached and stored in a separate file. Other parameters can include "creation-date", "modification-date", "read-date", and "size".

ContentDisposition refers to the presentation and storage parameters for the entire message. Use TIdAttachment.ContentDisposition to access values for a given attachment in MessageParts.

property ContentTransferEncoding: string;

• 7bit - Message contains 7-bit un-encoded US-ASCII data (Default).

• 8bit - Message contains 8-bit un-encoded data.

• binary - Message contains an un-encoded octet stream.

• quoted-printable - Message contents transformed to 7-bit US-ASCII using quoted-printable encoding algorithm.

• base64 - Message contents transformed to 7-bit US-ASCII using Base64 encoding algorithm.

Use ContentType to determine the original media family and type for a message.

property ContentType: string;

• text/plain

• text/html

• text/xml

• text/enhanced

• image/jpeg

• image/gif

• audio/basic

• audio/au

• video/mpeg

• application/octet-stream

• application/postscript

• application/ms-word

• application/ms-excel

• application/rtf

• multipart/mixed

• multipart/alternative

• multipart/parallel

• multipart/related

• message/rfc822

• message/external-body

Use ContentTransferEncoding to identify the encoding scheme for the message.

property Date: TDateTime;

property Encoding: TIdMessageEncoding;

• meMIME - Uses a MIME encoding algorithm.

• meUU - Uses the UUEncode encoding algorithm.

When the value in Encoding is changed, the corresponding textual representation for the algortihm is stored in AttachmentEncoding; for example: "MIME" or "UUE".

Encoding is used in GenerateHeader to insure that ContentType and Charset reflect the values found in attachments stored in MessageParts.

The default value for Encoding is meMIME as assigned in the Create constructor.

property ExtraHeaders: TIdHeaderList;

property Flags: TIdMessageFlagsSet;

Flags may contain one or more of the enumerated values in TIdMessageFlags.

property From: TIdEmailAddressItem;

property Headers: TIdHeaderList;

property IsEncoded: Boolean;

When IsEncoded is True, use MessageParts to access the text of the message body. When IsEncoded is False, the message body contains ASCII text and can be updated using Body.

property MessageParts: TIdMessageParts;

MessageParts is used when IsEncoded is set to True (on sending), or NoDecode is set to false for receiving.

property MIMEBoundary: TIdMIMEBoundary;

property MsgId: string;

property NewsGroups: TStrings;

property NoDecode: Boolean;

When NoDecode is True, the message will be retrieved and added to MessageParts as MIME-encoded attachments. There will be one MessagePart (TIdText type) added for the message Body, and additional MessagePart items (TIdAttachment type) for each message attachment. Body will be empty.

To read a message for a POP3 client, you can use the following code:

    Msg.NoDecode := false;
    APOP.Retrieve(1, Msg);

    for i := 0 to Pred(Msg.MessageParts.Count) do
    begin
      //general attachments
      if (Msg.MessageParts.Items[i] is TIdAttachment) then
      begin
        lstAttachments.Add(TIdAttachment(Msg.MessageParts.Items[i]).Filename);
      end

      //body text
      else
      begin
        if Msg.MessageParts.Items[intIndex] is TIdText then
        begin
          Memo1.Lines.AddStrings(TIdText(Msg.MessageParts.Items[i]).Body);
        end
      end;
    end;

When NoDecode is False, the message will be retreived and the message body is stored in Body in its MIME-encoded form.

property NoEncode: Boolean;

The default value for NoEncode is ID_MSG_NODECODE as assigned in the Create constructor. NoEncode is used in TIdMessageClient.SendMsg. When NoEncode is True, Headers and the optional Body for the message will be written by the message client using WriteStrings. Note: When NoEncode is True, other message parts for the message are not sent by the message client.

property Organization: string;

property Priority: TIdMessagePriority;

• mpHighest - The message should be given the highest priority

• mpHigh - This message should be given a high priority

• mpNormal - This message should be given the normal priority. This is the default value.

• mpLow - This message should be given a low priority

• mpLowest - This message should be given the lowest priority

property ReceiptRecipient: TIdEmailAddressItem;

property Recipients: TIdEmailAddressList;

property References: string;

References is used by NNTP newsreader applications to create a threaded article display.

property ReplyTo: TIdEmailAddressList;

property Sender: TIdEmailAddressItem;

property Subject: string;

property UID: String;

For messages retrieved using TIdIMAP4, UID will contain the string representation of the persistent 32-bit integer value stored in mailbox data associted with the message envelope. The value in UID is assigned when a message instance is created and updated in the message collection used in TIdIMAP4.UIDRetrieveAllEnvelopes.

For messages retrieved using TIdPOP3, UID may contain the arbitrary 70-byte value (maximum) which identifies a message in the POP3 maildrop. In POP3, individual byte values in UID must be in the range 0x21 to 0x7E. Note: Messages marked as deleted in the POP3 maildrop are not returned with a UID value.

property UseNowForDate: Boolean;

procedure AddHeader(const Value: string);

AddHeader can be used to add an experimental header after the message has loaded the header values in TIdMessageClient and set property values using ProcessHeaders.

Note: AddHeader does not perform line folding for header values.

procedure Clear; virtual;

Clear calls ClearHeader to remove the contents of the message header. Clear calls ClearBody to remove the contents of the message body.

procedure ClearBody;

Use ClearHeader to remove the contents the message Header, or Clear to remove both the Header and the Body of the message.

procedure ClearHeader;

• CcList

• BccList

• Date

• From

• NewsGroups

• Organization

• References

• ReplyTo

• Subject

• Recipients

• Priority

• ReceiptRecipient

• ContentType

• CharSet

• ContentTransferEncoding

• ContentDisposition

• Sender

• Headers

• ExtraHeaders

• MIMEBoundary

• UseNowForDate

• Flags

Use ClearBody to remove the contents the message Body, or Clear to remove both the Header and the Body of the message.

constructor Create(AOwner: TComponent); override;

• Body

• Recipients

• BccList

• CcList

• MessageParts

• NewsGroups

• Headers

• From

• ReplyTo

• Sender

• ExtraHeaders

• ReceiptRecipient

• MIMEBoundary

• NoDecode

Create also calls Clear to insure that Headers and Body are reset to their empty state.

destructor Destroy; override;

Destroy calls the inherited Destroy method to complete destruction of the object instance.

function GenerateHeader: TIdHeaderList;

• From

• Subject

• To

• Cc

• Newsgroups

• Content-Type

• MIME-Version

• Content-Transfer-Encoding

• Sender

• Reply-To

• Organization

• Disposition-Notification-To

• References

• Date

• X-Priority

• X-Library

For the Content-Type header, GenerateHeader compares the MIME Encoding for the message to the message encoders used for any MessageParts. If a message encoder contains a Charset value, it is appended to ContentType. If Ecoding contains a value other than meMIME, and the message has multipart/related or multipart/alternative message parts, an EIdMessageException will be raised.

GenerateHeader appends all values in ExtraHeaders to the TIdHeaderList return value. The application must free the TIdHeaderList returned by GenerateHeader.

function GetUseNowForDate: Boolean;

procedure LoadFromFile(const AFileName: string; const AHeadersOnly: Boolean = False);

LoadFromFile creates an instance of TFileStream to be used to reading the values for the message instance. The file stream is created using the file mode constants fmOpenRead and fmShareDenyWrite. LoadFromFile calls LoadFromStream using the stream to perform the physical input operation. The TFileStream instance is freed prior to exiting from the method.

When AHeadersOnly is False, only header values up to and including the blank line delimiter in RFC message headers will be read from the input file. When AHeadersOnly is True, both message Headers and MessageParts will be read into the message instance.

Use SaveToFile to create a file suitable for use with LoadFromFile. Use LoadFromSteam to read message contents from a TStream descendant. Use SaveToStream to create a stream containing values suitable for use with LoadFromSteam.

Note: Both LoadFromFile and LoadFromStream are designed to handle messages written using the SaveToStream or SavedToFile methods in the Indy TIdMessage component. These methods create an encoded version of the message contents that matches the protocol tranmissions used when the message is transmitted using TIdSMTP including the message terminator characters (CRLF.CRLF). If you are trying to import .EML message files from MS Outlook Express, or another email client, make sure that the text file contains the message terminator sequence. An exception will be raised if LoadFromFile or LoadFromStream are used to load files that do not include the message terminator sequence.

procedure LoadFromStream(AStream: TStream; const AHeadersOnly: Boolean = False);

AStream is a TStream descendant and represents the data source that will be used read values to be stored in the message instance. AStream can be any TStream descendant suitable for use in the as the input stream in a TIdIOHandlerStream instance. Note: The current position in AStream is not changed at any time during the LoadFromStream method. LoadFromStream uses the current stream position to perform the physical input operation, and leaves the stream at the position following the read operation.

AHeadersOnly indicates if only message headers should be loaded for the message instance. When AHeadersOnly is False, the entire message including all Headers and MessageParts will be loaded from AStream.

LoadFromStream creates an instance of TIdMessageClient, and calls TIdMessageClient.ProcessMessage to perform the physical input required to load values into the message instance. The TIdMessageClient instance is freed prior to exiting from the method.

Note: Both LoadFromFile and LoadFromStream are designed to handle messages written using the SaveToStream or SavedToFile methods in the Indy TIdMessage component. These methods create an encoded version of the message contents that matches the protocol tranmissions used when the message is transmitted using TIdSMTP including the message terminator characters (CRLF.CRLF). If you are trying to import .EML message files from MS Outlook Express, or another email client, make sure that the text file contains the message terminator sequence. An exception will be raised if LoadFromFile or LoadFromStream are used to load files that do not include the message terminator sequence.

procedure ProcessHeaders;

• CCList

• ContentDisposition

• ContentTransferEncoding

• ContentType

• Date

• From

• MIMEBoundary

• MsgId

• Newsgroups

• Organization

• Priority

• ReceiptRecipient

• Recipients

• References

• ReplyTo

• Sender

• Subject

procedure SaveToFile(const AFileName: string; const AHeadersOnly: Boolean = False);

procedure SaveToStream(AStream: TStream; const AHeadersOnly: Boolean = False);

AStream is a TStream descendant and represents the destination that will be used to write values in the message instance. AStream can be any TStream descendant suitable for use as the output stream in a TIdIOHandlerStream instance. Note: The current position in AStream is not changed at any time during the SaveToStream method. SaveToStream uses the current stream position to perform the physical output operation, and leaves the stream at the position following the write operation.

AHeadersOnly indicates if only message headers should be written for the message instance. When AHeadersOnly is False, the entire message including all Headers and MessageParts will be stored in AStream.

SaveToStream creates an instance of TIdMessageClient, and calls TIdMessageClient.SaveMsg to perform the physical output required to store values from the message instance. The TIdMessageClient instance is freed prior to exiting from the method.

procedure SetBody(const Value: TStrings);

procedure SetExtraHeaders(const Value: TIdHeaderList);

procedure SetNewsGroups(const Value: TStrings);

procedure SetUseNowForDate(const Value: Boolean);

property OnInitializeISO: TIdInitializeIsoEvent;