Dacons LLP Mailit for C/C++ Version 1.0.8

Emai::MessagePart Class Reference

EmaiMessagePart wrapper class.
MessagePart represents message part of the RFC822 message. More...

#include <EmaiMessage.hpp>

Inheritance diagram for Emai::MessagePart:

Emai::Object< EmaiMessagePart > List of all members.

Public Member Functions

 ~MessagePart ()
 MessagePart (const EmaiPartData &inData, EmaiOptions inOptions=EmaiNullOptions)
 Constructor.
 MessagePart (EmaiMessagePart inMessagePart, bool inAddRef)
 Constructor.
 MessagePart (const MessagePart &inCopy)
 Constructor.
MessagePartoperator= (const MessagePart &inCopy)
void AddSubParts (const EmaiMessagePart inSubParts[], EmaiUint32 inSubPartCount, EmaiOptions inOptions=EmaiNullOptions)
 Appends subparts to the composite part, created via EmaiMessagePartCreateComposite.
void GetSubParts (EmaiMessagePart outSubParts[], EmaiUint32 *ioSubPartCount, EmaiOptions inOptions=EmaiNullOptions)
 Retrieves subparts from composite message part.
void GetData (EmaiPartData &outData, EmaiOptions inOptions=EmaiNullOptions)
 Retrieves the data from the message part.

Detailed Description

EmaiMessagePart wrapper class.
MessagePart represents message part of the RFC822 message.

See also:
EmaiMessagePart

Definition at line 298 of file EmaiMessage.hpp.


Member Function Documentation

void Emai::MessagePart::AddSubParts ( const EmaiMessagePart  inSubParts[],
EmaiUint32  inSubPartCount,
EmaiOptions  inOptions = EmaiNullOptions 
) [inline]

Appends subparts to the composite part, created via EmaiMessagePartCreateComposite.

Parameters:
inSubParts - an array of message parts to be added to the composite part
inSubPartCount - number of items in inSubPart array
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiMessagePartAddSubParts

Definition at line 828 of file EmaiMessage.hpp.

References Emai::CheckErrorCode(), EmaiMessagePartAddSubParts(), and Emai::Object< EmaiMessagePart >::mObject.

00832 {
00833     CheckErrorCode(EmaiMessagePartAddSubParts(
00834                 mObject, inSubPart, inSubPartCount, inOptions));
00835 }

void Emai::MessagePart::GetSubParts ( EmaiMessagePart  outSubParts[],
EmaiUint32 *  ioSubPartCount,
EmaiOptions  inOptions = EmaiNullOptions 
) [inline]

Retrieves subparts from composite message part.

Parameters:
outSubParts - if non-NULL on successful function exit this array is filled with subparts, otherwise ioSubPartCount will contain number of subparts
ioSubPartCount - if outSubParts is non-NULL, the number of items at the outSubParts array is passed in function and number of actually written items is returned on exit. If outSubParts is NULL, input value of the parameter is ignored, and number of subparts is returned on function exit
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiMessagePartGetSubParts

Definition at line 838 of file EmaiMessage.hpp.

References Emai::CheckErrorCode(), EmaiMessagePartGetSubParts(), and Emai::Object< EmaiMessagePart >::mObject.

00842 {
00843     CheckErrorCode(EmaiMessagePartGetSubParts(
00844                 mObject, outSubParts, ioSubPartCount, inOptions));
00845 }

void Emai::MessagePart::GetData ( EmaiPartData outData,
EmaiOptions  inOptions = EmaiNullOptions 
) [inline]

Retrieves the data from the message part.

Parameters:
outData - on successful function exit is filled with message part data, this data is stored internally in the message part object - you should not modify of release it
inOptions - not used in current version, use EmaiNullOptions
See also:
EmaiMessagePartGetData

Definition at line 848 of file EmaiMessage.hpp.

References Emai::CheckErrorCode(), EmaiMessagePartGetData(), and Emai::Object< EmaiMessagePart >::mObject.

Referenced by Emai::MessagePartEnumerator::ProcessMessagePart().

00852 {
00853     CheckErrorCode(EmaiMessagePartGetData(
00854                 mObject, &outData, inOptions));
00855 }


The documentation for this class was generated from the following file: