MIME Class

Properties   Methods   Events   Config Settings   Errors  

The MIME class allows for the simple encoding and decoding of MIME structures, such as message attachments and file uploads.

Syntax

MIME

Remarks

The class may be used for decoding or encoding of messages. Message holds the content of the encoded message or the filename that holds the encoded data. The decoded data are provided in Parts properties.

To decode a MIME message, you should first assign either the whole message (headers and body) to Message or put the message headers into the MessageHeaders property and the message body or the filename holding it into the Message property. Calling DecodeFromFile or DecodeFromString directs the class to start parsing the message: it will fill out the ContentType and ContentTypeAttr properties with message content-type information, and it will enter information about message parts into the Parts properties, which includes part sizes, part content types, part content type attributes, part content disposition, part content disposition attributes, part encoding, part name, part filename, part headers, or part content (part-decoded string or part-decoded file) for each decoded part.

Calling the DecodeFromString or DecodeFromFile to decode does not actually decode the message but only parses it. The real decoding is done when the part content in the Parts properties is first accessed.

To encode data into a MIME message, you should first assign values for each part to either a part-decoded string or a part- decoded file in the Parts properties property, and optionally assign values to the other part attributes in the Parts properties. Assigning a value to the part-decoded string or a part-decoded file through the Parts properties, fills out automatically the part headers into the Parts properties for the respective part. Calling EncodeToFile or EncodeToString directs the class to fill out the Message with the message body and the MessageHeaders with the headers.

The Progress event is fired as the message is parsed and the data are decoded/encoded.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Boundary Property (MIME Class)

This property includes the boundary separating the MIME parts. It has a maximum length of 80 bytes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBoundary();
int SetBoundary(const char* lpszBoundary);

Unicode (Windows)
LPWSTR GetBoundary();
INT SetBoundary(LPCWSTR lpszBoundary);

char* ipworkssmime_mime_getboundary(void* lpObj);
int ipworkssmime_mime_setboundary(void* lpObj, const char* lpszBoundary);

QString GetBoundary();
int SetBoundary(QString qsBoundary);

Default Value

""

Remarks

This property contains the boundary separating the MIME parts and has a maximum length of 80 bytes. The class automatically generates a random boundary value during encoding, if no value is given. During decoding, this property is filled with the boundary from the actual MIME message.

The class will truncate any string longer than 80 bytes if assigned to Boundary.

Data Type

String

ContentType Property (MIME Class)

This property includes the value of the content-type header of the message that was encoded/decoded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContentType();
int SetContentType(const char* lpszContentType);

Unicode (Windows)
LPWSTR GetContentType();
INT SetContentType(LPCWSTR lpszContentType);

char* ipworkssmime_mime_getcontenttype(void* lpObj);
int ipworkssmime_mime_setcontenttype(void* lpObj, const char* lpszContentType);

QString GetContentType();
int SetContentType(QString qsContentType);

Default Value

""

Remarks

This property contains the value of the content-type header of the message that was encoded/decoded. The class filters it out from the MessageHeaders. It shows the user information about the type of the parts and their relation to each other.

The content-type attributes, such as filename, boundary, and charset, are held in this property.

Data Type

String

ContentTypeAttr Property (MIME Class)

This property includes the attributes of the content-type header of the message that was encoded or decoded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContentTypeAttr();
int SetContentTypeAttr(const char* lpszContentTypeAttr);

Unicode (Windows)
LPWSTR GetContentTypeAttr();
INT SetContentTypeAttr(LPCWSTR lpszContentTypeAttr);

char* ipworkssmime_mime_getcontenttypeattr(void* lpObj);
int ipworkssmime_mime_setcontenttypeattr(void* lpObj, const char* lpszContentTypeAttr);

QString GetContentTypeAttr();
int SetContentTypeAttr(QString qsContentTypeAttr);

Default Value

""

Remarks

This property contains content-type attributes such as "filename", "boundary", and "charset".

Data Type

String

Message Property (MIME Class)

This property contains the encoded message text or a path to a file that contains the encoded message text.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMessage(char* &lpMessage, int &lenMessage);
int SetMessage(const char* lpMessage, int lenMessage);

Unicode (Windows)
INT GetMessage(LPSTR &lpMessage, INT &lenMessage);
INT SetMessage(LPCSTR lpMessage, INT lenMessage);

int ipworkssmime_mime_getmessage(void* lpObj, char** lpMessage, int* lenMessage);
int ipworkssmime_mime_setmessage(void* lpObj, const char* lpMessage, int lenMessage);

QByteArray GetMessage();
int SetMessage(QByteArray qbaMessage);

Default Value

""

Remarks

This property contains the encoded message text or a path to a file that contains the encoded message text. The class fills out this property with the message body and MessageHeaders during encoding. The user may assign both the headers and the body to this property and leave MessageHeaders empty before decoding.

This property is not available at design time.

Data Type

Binary String

MessageHeaders Property (MIME Class)

This property includes the headers of the MIME message.

Syntax

• C++
• C
• Qt

IPWorksSMIMEList<IPWorksSMIMEHeader>* GetMessageHeaders();
int SetMessageHeaders(IPWorksSMIMEList<IPWorksSMIMEHeader>* val);

int ipworkssmime_mime_getmessageheadercount(void* lpObj);
int ipworkssmime_mime_setmessageheadercount(void* lpObj, int iMessageHeaderCount);

char* ipworkssmime_mime_getmessageheaderfield(void* lpObj, int messageheaderindex);
int ipworkssmime_mime_setmessageheaderfield(void* lpObj, int messageheaderindex, const char* lpszMessageHeaderField);

char* ipworkssmime_mime_getmessageheadervalue(void* lpObj, int messageheaderindex);
int ipworkssmime_mime_setmessageheadervalue(void* lpObj, int messageheaderindex, const char* lpszMessageHeaderValue);

int GetMessageHeaderCount();
int SetMessageHeaderCount(int iMessageHeaderCount);

QString GetMessageHeaderField(int iMessageHeaderIndex);
int SetMessageHeaderField(int iMessageHeaderIndex, QString qsMessageHeaderField);

QString GetMessageHeaderValue(int iMessageHeaderIndex);
int SetMessageHeaderValue(int iMessageHeaderIndex, QString qsMessageHeaderValue);

Remarks

This property contains the headers of the MIME message. The class fills out this property upon encoding. The user should use them as additional headers when emailing the Message.

During decoding, if this property is empty, the class will try to find the headers in the beginning of the Message and then will fill out this property accordingly.

Data Type

IPWorksSMIMEHeader

MessageHeadersString Property (MIME Class)

This property includes the string version of the MIME message headers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMessageHeadersString();
int SetMessageHeadersString(const char* lpszMessageHeadersString);

Unicode (Windows)
LPWSTR GetMessageHeadersString();
INT SetMessageHeadersString(LPCWSTR lpszMessageHeadersString);

char* ipworkssmime_mime_getmessageheadersstring(void* lpObj);
int ipworkssmime_mime_setmessageheadersstring(void* lpObj, const char* lpszMessageHeadersString);

QString GetMessageHeadersString();
int SetMessageHeadersString(QString qsMessageHeadersString);

Default Value

""

Remarks

The component fills out MessageHeadersString upon encoding. The user should use these strings as additional headers when emailing the Message.

This property contains a string version of the MIME message headers. During decoding, if this property is empty, the class will try to find the headers in the beginning of the Message and will fill out this property accordingly.

Data Type

String

Parts Property (MIME Class)

This property contains information about all parts of a MIME message.

Syntax

• C++
• C
• Qt

IPWorksSMIMEList<IPWorksSMIMEMIMEPart>* GetParts();
int SetParts(IPWorksSMIMEList<IPWorksSMIMEMIMEPart>* val);

int ipworkssmime_mime_getpartcount(void* lpObj);
int ipworkssmime_mime_setpartcount(void* lpObj, int iPartCount);

char* ipworkssmime_mime_getpartcontentdisposition(void* lpObj, int partidx);
int ipworkssmime_mime_setpartcontentdisposition(void* lpObj, int partidx, const char* lpszPartContentDisposition);

char* ipworkssmime_mime_getpartcontentdispositionattr(void* lpObj, int partidx);
int ipworkssmime_mime_setpartcontentdispositionattr(void* lpObj, int partidx, const char* lpszPartContentDispositionAttr);

char* ipworkssmime_mime_getpartcontentid(void* lpObj, int partidx);
int ipworkssmime_mime_setpartcontentid(void* lpObj, int partidx, const char* lpszPartContentId);

char* ipworkssmime_mime_getpartcontenttype(void* lpObj, int partidx);
int ipworkssmime_mime_setpartcontenttype(void* lpObj, int partidx, const char* lpszPartContentType);

char* ipworkssmime_mime_getpartcontenttypeattr(void* lpObj, int partidx);
int ipworkssmime_mime_setpartcontenttypeattr(void* lpObj, int partidx, const char* lpszPartContentTypeAttr);

int ipworkssmime_mime_setpartdecodedfile(void* lpObj, int partidx, const char* lpszPartDecodedFile);

int ipworkssmime_mime_getpartdecodedstring(void* lpObj, int partidx, char** lpPartDecodedString, int* lenPartDecodedString);
int ipworkssmime_mime_setpartdecodedstring(void* lpObj, int partidx, const char* lpPartDecodedString, int lenPartDecodedString);

int ipworkssmime_mime_getpartencoding(void* lpObj, int partidx);
int ipworkssmime_mime_setpartencoding(void* lpObj, int partidx, int iPartEncoding);

char* ipworkssmime_mime_getpartfilename(void* lpObj, int partidx);
int ipworkssmime_mime_setpartfilename(void* lpObj, int partidx, const char* lpszPartFileName);

char* ipworkssmime_mime_getpartheaders(void* lpObj, int partidx);
int ipworkssmime_mime_setpartheaders(void* lpObj, int partidx, const char* lpszPartHeaders);

char* ipworkssmime_mime_getpartname(void* lpObj, int partidx);
int ipworkssmime_mime_setpartname(void* lpObj, int partidx, const char* lpszPartName);

int ipworkssmime_mime_setpartinputstream(void* lpObj, int partidx, IPWorksSMIMEStream* sPartInputStream);

int ipworkssmime_mime_getpartsize(void* lpObj, int partidx);

int GetPartCount();
int SetPartCount(int iPartCount);

QString GetPartContentDisposition(int iPartIdx);
int SetPartContentDisposition(int iPartIdx, QString qsPartContentDisposition);

QString GetPartContentDispositionAttr(int iPartIdx);
int SetPartContentDispositionAttr(int iPartIdx, QString qsPartContentDispositionAttr);

QString GetPartContentId(int iPartIdx);
int SetPartContentId(int iPartIdx, QString qsPartContentId);

QString GetPartContentType(int iPartIdx);
int SetPartContentType(int iPartIdx, QString qsPartContentType);

QString GetPartContentTypeAttr(int iPartIdx);
int SetPartContentTypeAttr(int iPartIdx, QString qsPartContentTypeAttr);

int SetPartDecodedFile(int iPartIdx, QString qsPartDecodedFile);

QByteArray GetPartDecodedString(int iPartIdx);
int SetPartDecodedString(int iPartIdx, QByteArray qbaPartDecodedString);

int GetPartEncoding(int iPartIdx);
int SetPartEncoding(int iPartIdx, int iPartEncoding);

QString GetPartFileName(int iPartIdx);
int SetPartFileName(int iPartIdx, QString qsPartFileName);

QString GetPartHeaders(int iPartIdx);
int SetPartHeaders(int iPartIdx, QString qsPartHeaders);

QString GetPartName(int iPartIdx);
int SetPartName(int iPartIdx, QString qsPartName);

int SetPartInputStream(int iPartIdx, IPWorksSMIMEStream* sPartInputStream);

int GetPartSize(int iPartIdx);

Remarks

This property contains information about all parts of a MIME message. A MIME message consists of different parts, separated by either a user-specified or an auto-generated boundary. Each part has its own set of headers that are contained in the Headers field.

The MIMEPARTS collection is filled out by the class when a call to either DecodeFromFile or DecodeFromString is made. However, when the EncodeToFile or EncodeToString methods are called, the class encodes the data given in either DecodedFile or DecodedString into a MIME message.

Data Type

IPWorksSMIMEMIMEPart

Config Method (MIME Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworkssmime_mime_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DecodeFromFile Method (MIME Class)

This method decodes from a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DecodeFromFile();

Unicode (Windows)
INT DecodeFromFile();

int ipworkssmime_mime_decodefromfile(void* lpObj);

int DecodeFromFile();

Remarks

This method decodes the data file given in Message and optionally MessageHeaders and fills out the Parts properties for each decoded part.

Example. Decoding from a File:

MIMEControl.Message = "C:\filename.txt" MIMEControl.DecodeFromFile

In this example, C:\filename.txt must contain the MIME headers and body. If not, the MessageHeaders property must be set to the appropriate MIME headers.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DecodeFromStream Method (MIME Class)

This method decodes from a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DecodeFromStream(IPWorksSMIMEStream* sInputStream);

Unicode (Windows)
INT DecodeFromStream(IPWorksSMIMEStream* sInputStream);

int ipworkssmime_mime_decodefromstream(void* lpObj, IPWorksSMIMEStream* sInputStream);

int DecodeFromStream(IPWorksSMIMEStream* sInputStream);

Remarks

This method decodes from a stream. It is the same as DecodeFromString, but now the MIME message is passed to this method as a stream.

This method decodes the data given by the InputStream and optionally MessageHeaders and fills out the Parts properties.

Example. Decoding a Mail Message:

MIMEControl.MessageHeaders.AddRange(MailControl.MessageHeaders) MIMEControl.DecodeFromStream(InputStream)

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DecodeFromString Method (MIME Class)

This method decodes from a string.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DecodeFromString();

Unicode (Windows)
INT DecodeFromString();

int ipworkssmime_mime_decodefromstring(void* lpObj);

int DecodeFromString();

Remarks

This method decodes from a string. It is the same as DecodeFromFile, but now the Message denotes the real encoded message rather than a filename.

This method decodes the data given in Message and optionally MessageHeaders and fills out the Parts properties.

Example. Decoding a Mail Message:

MIMEControl.MessageHeadersString = MailControl.MessageHeaders MIMEControl.Message = MailControl.MessageText MIMEControl.DecodeFromString

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DecodePart Method (MIME Class)

This method decodes the specified part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DecodePart(int iindex, int *lpSize = NULL);

Unicode (Windows)
LPSTR DecodePart(INT iindex, LPINT lpSize = NULL);

char* ipworkssmime_mime_decodepart(void* lpObj, int iindex, int *lpSize);

QByteArray DecodePart(int iindex);

Remarks

This method decodes the part specified by Index and returns the decoded part data.

DecodeFromString or DecodeFromFile must be called before calling this method. Calling this method will return the decoded bytes, and in addition, the DecodedString field will be populated with the string representation of the decoded data.

Example. Decoding a Specified Part: mime.MessageHeadersString = myMessageHeaders; mime.Message = myMessageBody; mime.DecodeFromString(); byte[] myPartContent = await mime.DecodePart(0);

Error Handling (C++)

This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DecodePartToFile Method (MIME Class)

This method decodes the specified part to a file on disk.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* DecodePartToFile(int iindex);

Unicode (Windows)
LPWSTR DecodePartToFile(INT iindex);

char* ipworkssmime_mime_decodeparttofile(void* lpObj, int iindex);

QString DecodePartToFile(int iindex);

Remarks

This method decodes the part specified by Index to a temporary file. The full path to the temporary file is returned by this method. The user is responsible for deleting the temporary file.

DecodeFromString or DecodeFromFile must be called before calling this method.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

EncodeToFile Method (MIME Class)

This method encodes to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EncodeToFile();

Unicode (Windows)
INT EncodeToFile();

int ipworkssmime_mime_encodetofile(void* lpObj);

int EncodeToFile();

Remarks

This method encodes the data given in Parts properties (either a decoded file or a decoded string) into a MIME message at Message and MessageHeaders using the values optionally given in Parts properties. To encode several objects into a MIME envelope, the user should first clear any old values left in the Parts properties.

The class will check for each item in Parts properties (first the decoded file and then the decoded string) for the data to encode.

The encoded message will be saved in the file pointed to by Message; the message headers will be held by MessageHeaders.

Example. Encoding Data:

MIMEControl.ResetData() MIMEControl.PartCount = 2 MIMEControl.PartDecodedString(0) = "This is plain text data" MIMEControl.PartEncoding(0) = peQuotedPrintable MIMEControl.PartContentType(0) = "text/plain" MIMEControl.PartDecodedFile(1) = "C:\filename.txt" MIMEControl.Message = "temp.tmp" MIMEControl.EncodeToFile()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

EncodeToStream Method (MIME Class)

This method encodes to a stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EncodeToStream(IPWorksSMIMEStream* sOutputStream);

Unicode (Windows)
INT EncodeToStream(IPWorksSMIMEStream* sOutputStream);

int ipworkssmime_mime_encodetostream(void* lpObj, IPWorksSMIMEStream* sOutputStream);

int EncodeToStream(IPWorksSMIMEStream* sOutputStream);

Remarks

This method encodes to a stream. It is the same as EncodeToString, but the encoded data are written to a stream instead of to the Message property.

This method encodes the data given in Parts collection into a MIME message. The Message gets written to the specified OutputStream and MessageHeaders using the values optionally given in the Parts collection. To encode several objects into a MIME envelope, the user should first clear any old values left in the Parts collection by calling ResetData.

The class will check each item in the Parts collection (first the decoded file and then the decoded string) for the data to encode.

The encoded message will be written to the specified OutputStream, and the message headers will be held by MessageHeaders.

Example. Encoding Data:

MIMEControl.ResetData() MIMEControl.Parts.Add(new MIMEPart()) MIMEControl.Parts.Add(new MIMEPart()) MIMEControl.Parts[0].DecodedString = "This is plain text data" MIMEControl.Parts[0].Encoding = peQuotedPrintable MIMEControl.Parts[0].ContentType = "text/plain" MIMEControl.Parts[1].DecodedFile = "C:\filename.txt" MIMEControl.EncodeToStream(OutputStream)

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

EncodeToString Method (MIME Class)

This method encodes to a string.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EncodeToString();

Unicode (Windows)
INT EncodeToString();

int ipworkssmime_mime_encodetostring(void* lpObj);

int EncodeToString();

Remarks

This method encodes to a string. It is the same as EncodeToFile but the encoded data are held in the Message property rather than saved to a file.

This method encodes the data given in the Parts properties into a MIME message. The message gets stored in Message and MessageHeaders using the values optionally given in Parts properties. To encode several objects into a MIME envelope, the user should first clear any old values left in the Parts properties by calling ResetData.

The class will check each item in the Parts properties (first the decoded file and then the decoded string) for the data to encode.

The encoded message will be stored in the Message property; the message headers will be held by MessageHeaders.

Example. Encoding Data:

MIMEControl.ResetData() MIMEControl.PartCount = 2 MIMEControl.PartDecodedString(0) = "This is plain text data" MIMEControl.PartEncoding(0) = peQuotedPrintable MIMEControl.PartContentType(0) = "text/plain" MIMEControl.PartDecodedFile(1) = "C:\filename.txt" MIMEControl.EncodeToString()

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (MIME Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkssmime_mime_reset(void* lpObj);

int Reset();

Remarks

This method will reset the class's properties to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ResetData Method (MIME Class)

This method resets the values of all headers and part properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetData();

Unicode (Windows)
INT ResetData();

int ipworkssmime_mime_resetdata(void* lpObj);

int ResetData();

Remarks

This method resets the values of all headers and part properties. It is an easy way to reset the class's properties before starting to populate the part properties with new values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (MIME Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(MIMEErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} MIMEErrorEventParams;


Unicode (Windows)
virtual INT FireError(MIMEErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} MIMEErrorEventParams;

#define EID_MIME_ERROR 1

virtual INT IPWORKSSMIME_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class MIMEErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(MIMEErrorEventParams *e);

// Or, subclass MIME and override this emitter function.
virtual int FireError(MIMEErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (MIME Class)

This event is fired every time a header is parsed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(MIMEHeaderEventParams *e);

typedef struct {
  int PartIndex;
  const char *Field;
  const char *Value;
  int lenValue;
  int reserved;
} MIMEHeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(MIMEHeaderEventParams *e);

typedef struct {
  INT PartIndex;
  LPCWSTR Field;
  LPCSTR Value;
  INT lenValue;
  INT reserved;
} MIMEHeaderEventParams;

#define EID_MIME_HEADER 2

virtual INT IPWORKSSMIME_CALL FireHeader(INT &iPartIndex, LPSTR &lpszField, LPSTR &lpValue, INT &lenValue);

class MIMEHeaderEventParams {
public:
  int PartIndex();

  const QString &Field();

  const QByteArray &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(MIMEHeaderEventParams *e);

// Or, subclass MIME and override this emitter function.
virtual int FireHeader(MIMEHeaderEventParams *e) {...}

Remarks

The PartIndex parameter contains the index of the part containing the current header. If the header is from the MIME body, this value will be -1. The Field parameter contains the name of the MIME header. The Value parameter contains the header contents. The Header event is fired when a header is parsed, which occurs for each header of the message when DecodeFromFile, DecodeFromString, or DecodeFromStream is called.

Progress Event (MIME Class)

This event shows the progress of decoding or encoding the input data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(MIMEProgressEventParams *e);

typedef struct {
  int PercentDone;
  int reserved;
} MIMEProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(MIMEProgressEventParams *e);

typedef struct {
  INT PercentDone;
  INT reserved;
} MIMEProgressEventParams;

#define EID_MIME_PROGRESS 3

virtual INT IPWORKSSMIME_CALL FireProgress(INT &iPercentDone);

class MIMEProgressEventParams {
public:
  int PercentDone();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(MIMEProgressEventParams *e);

// Or, subclass MIME and override this emitter function.
virtual int FireProgress(MIMEProgressEventParams *e) {...}

Remarks

The Progress allows the user to visualize the progress of processing the input data.

The PercentDone parameter shows what percentage of the input has been read.

Header Type

This is an HTTP header as it is received from the server.

Syntax

IPWorksSMIMEHeader (declared in ipworkssmime.h)

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a Field, and its corresponding Value.

Fields

Constructors

Header()

Header(const char* lpszField, const char* lpszValue)

MIMEPart Type

This is a part of the MIME message.

Syntax

IPWorksSMIMEMIMEPart (declared in ipworkssmime.h)

Remarks

Each MIME message is split into parts. A message must have at least one part to be a valid MIME message. The message itself is split into the MessageHeaders and the Message body. The body is then split into MIME parts by a specified or generated Boundary. Each part of a MIME message has its own Headers as well. These headers describe the MIMEPart and its contents.

The decoded data will be held in DecodedString or otherwise will be saved in a temporary file given by DecodedFile when the user asks for the value of the respective field.

If the encoded data are file data, the decoded file(s) will be given in the DecodedFile field. Otherwise, the decoded data will be in the DecodedString field.

When the EncodeToString method is called, the class will check for each item in the Parts properties (first the DecodedFile and then the DecodedString) for the data to encode.

Fields

Constructors

MIMEPart()

MIMEPart(const char* lpszDecodedFile)

MIMEPart(const char* lpDecodedString, int lenDecodedString)

MIMEPart(IPWorksSMIMEStream* sPartInputStream)

IPWorksSMIMEList Type

Syntax

IPWorksSMIMEList<T> (declared in ipworkssmime.h)

Remarks

IPWorksSMIMEList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the MIME class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

IPWorksSMIMEStream Type

Syntax

IPWorksSMIMEStream (declared in ipworkssmime.h)

Remarks

The MIME class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksSMIMEStream interface and pass the MIME class an instance of that concrete class.

When implementing the IPWorksSMIMEStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (MIME Class)

MIME Config Settings

Base Config Settings

Trappable Errors (MIME Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

MIME Errors