CkMime C++ Reference Documentation

CkMime

Current Version: 9.5.0.73

Chilkat MIME allows you to easily create and manipulate MIME and S/MIME messages from within your applications.

Object Creation

// Local variable on the stack
CkMime obj;

// Dynamically allocate/delete
CkMime *pObj = new CkMime();
// ...
delete pObj;

Properties

Boundary
void get_Boundary(CkString &str);
const char *boundary(void);
void put_Boundary(const char *ansiOrUtf8Str);

The boundary string for a multipart MIME message.

It is the value of the boundary attribute of the Content-Type header field. For example, if the Content-Type header is this:

Content-Type: multipart/mixed; boundary="------------080707010302060306060800"
then the value of the Boundary property is "------------080707010302060306060800".

When building multipart MIME messages, the boundary is automatically generated by methods such as NewMultipartMixed, to be a unique and random string, so explicitly setting the boundary is usually not necessary.

top
Charset
void get_Charset(CkString &str);
const char *charset(void);
void put_Charset(const char *ansiOrUtf8Str);

The value of the "charset" attribute of the Content-Type header field. For example, if the Content-Type header is this:

Content-Type: text/plain; charset="iso-8859-1"
then the value of the Charset property is "iso-8859-1".

top
ContentType
void get_ContentType(CkString &str);
const char *contentType(void);
void put_ContentType(const char *ansiOrUtf8Str);

The MIME content type, such as "text/plain", "text/html", "image/gif", "multipart/alternative", "multipart/mixed", etc.

It is the value of the Content-Type header field, excluding any attributes. For example, if the Content-Type header is this:

Content-Type: multipart/mixed; boundary="------------080707010302060306060800"
then the value of the ContentType property is "multipart/mixed".

top
CurrentDateTime
void get_CurrentDateTime(CkString &str);
const char *currentDateTime(void);

Returns the current date/time in RFC 822 format.

More Information and Examples
top
DebugLogFilePath
void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
Disposition
void get_Disposition(CkString &str);
const char *disposition(void);
void put_Disposition(const char *ansiOrUtf8Str);

The value of the Content-Disposition header field, excluding any attributes. For example, if the Content-Disposition header is this:

Content-Disposition: attachment; filename="starfish.gif"
then the value of the Disposition property is "attachment".

More Information and Examples
top
Encoding
void get_Encoding(CkString &str);
const char *encoding(void);
void put_Encoding(const char *ansiOrUtf8Str);

The value of the Content-Transfer-Encoding header field. Typical values are "base64", "quoted-printable", "7bit", "8bit", "binary", etc. For example, if the Content-Transfer-Encoding header is this:

Content-Transfer-Encoding: base64
then the value of the Encoding property is "base64".

More Information and Examples
top
Filename
void get_Filename(CkString &str);
const char *filename(void);
void put_Filename(const char *ansiOrUtf8Str);

The value of the "filename" attribute of the Content-Disposition header field. For example, if the Content-Disposition header is this:

Content-Disposition: attachment; filename="starfish.gif"
then the value of the Filename property is "starfish.gif".

More Information and Examples
top
LastErrorHtml
void get_LastErrorHtml(CkString &str);
const char *lastErrorHtml(void);

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
void get_LastErrorText(CkString &str);
const char *lastErrorText(void);

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
void get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Micalg
void get_Micalg(CkString &str);
const char *micalg(void);
void put_Micalg(const char *ansiOrUtf8Str);

The value of the "micalg" attribute of the Content-Type header field. For example, if the Content-Type header is this:

Content-Type: multipart/signed; protocol="application/x-pkcs7-signature"; micalg=sha1; 
  boundary="------------ms000908010507020408060303"
then the value of the Micalg property is "sha".

Note: The micalg attribute is only present in PKCS7 signed MIME. Setting the Micalg property has the effect of choosing the hash algorithm used w/ signing. Possible choices are "sha1", "md5", "sha256", "sha384", and "sha512". However, it is preferable to set the signing hash algorithm by setting the SigningHashAlg property instead.

top
Name
void get_Name(CkString &str);
const char *name(void);
void put_Name(const char *ansiOrUtf8Str);

The value of the "name" attribute of the Content-Type header field. For example, if the Content-Type header is this:

Content-Type: image/gif; name="starfish.gif"
then the value of the Name property is "starfish.gif".

More Information and Examples
top
NumEncryptCerts
int get_NumEncryptCerts(void);

The number of certificates found when decrypting S/MIME. This property is set after UnwrapSecurity is called.

top
NumHeaderFields
int get_NumHeaderFields(void);

The number of header fields. Header field names and values can be retrieved by index (starting at 0) by calling GetHeaderFieldName and GetHeaderFieldValue.

top
NumParts
int get_NumParts(void);

MIME messages are composed of parts in a tree structure. The NumParts property contains the number of direct children. To traverse an entire MIME tree, one would recursively descend the tree structure by iterating from 0 to NumParts-1, calling GetPart to get each direct child MIME object. The traversal would continue by iterating over each child's parts, and so on.

top
NumSignerCerts
int get_NumSignerCerts(void);

The number of certificates found when verifying signature(s). This property is set after UnwrapSecurity is called.

top
OaepHash
void get_OaepHash(CkString &str);
const char *oaepHash(void);
void put_OaepHash(const char *ansiOrUtf8Str);
Introduced in version 9.5.0.67

Selects the hash algorithm for use within OAEP padding when encrypting MIME using RSAES-OAEP. The valid choices are "sha1", "sha256", "sha384", "sha512",

top
OaepMgfHash
void get_OaepMgfHash(CkString &str);
const char *oaepMgfHash(void);
void put_OaepMgfHash(const char *ansiOrUtf8Str);
Introduced in version 9.5.0.71

Selects the MGF hash algorithm for use within OAEP padding when encrypting MIME using RSAES-OAEP. The valid choices are "sha1", "sha256", "sha384", "sha512", The default is "sha1".

top
OaepPadding
bool get_OaepPadding(void);
void put_OaepPadding(bool newVal);
Introduced in version 9.5.0.67

Selects the RSA encryption scheme when encrypting MIME. The default value is false, which selects RSAES_PKCS1-V1_5. If set to true, then RSAES_OAEP is used.

top
Pkcs7CryptAlg
void get_Pkcs7CryptAlg(CkString &str);
const char *pkcs7CryptAlg(void);
void put_Pkcs7CryptAlg(const char *ansiOrUtf8Str);

When the MIME is encrypted (using PKCS7 public-key encryption), this selects the underlying symmetric encryption algorithm. Possible values are: "aes", "des", "3des", and "rc2". The default value is "aes".

top
Pkcs7KeyLength
int get_Pkcs7KeyLength(void);
void put_Pkcs7KeyLength(int newVal);

When the MIME is encrypted (using PKCS7 public-key encryption), this selects the key length of the underlying symmetric encryption algorithm. The possible values allowed depend on the Pkcs7CryptAlg property. For "aes", the key length may be 128, 192, or 256. For "3des" the key length must be 192. For "des" the key length must be 40. For "rc2" the key length can be 40, 56, 64, or 128.

top
Protocol
void get_Protocol(CkString &str);
const char *protocol(void);
void put_Protocol(const char *ansiOrUtf8Str);

The value of the "protocol" attribute of the Content-Type header field. For example, if the Content-Type header is this:

Content-Type: multipart/signed; protocol="application/x-pkcs7-signature"; micalg=sha1; 
  boundary="------------ms000908010507020408060303"
then the value of the Protocol property is "application/x-pkcs7-signature".

top
SigningAlg
void get_SigningAlg(CkString &str);
const char *signingAlg(void);
void put_SigningAlg(const char *ansiOrUtf8Str);
Introduced in version 9.5.0.67

Selects the signature algorithm to be used when creating signed (PKCS7) MIME. The default value is "PKCS1-v1_5". This can be set to "RSASSA-PSS" (or simply "pss") to use the RSASSA-PSS signature scheme.

Note: This property only applies when signing with an RSA private key. It does not apply for ECC or DSA private keys.

More Information and Examples
top
SigningHashAlg
void get_SigningHashAlg(CkString &str);
const char *signingHashAlg(void);
void put_SigningHashAlg(const char *ansiOrUtf8Str);

Selects the underlying hash algorithm used when creating signed (PKCS7) MIME. Possible values are "sha1", "sha256", "sha384", "sha512", "md5", and "md2".

top
UnwrapExtras
bool get_UnwrapExtras(void);
void put_UnwrapExtras(bool newVal);

Controls whether extra (informative) header fields are added to the MIME message when unwrapping security.

More Information and Examples
top
UseMmDescription
bool get_UseMmDescription(void);
void put_UseMmDescription(bool newVal);

Controls whether the boilerplate text "This is a multi-part message in MIME format." is used as the body content of a multipart MIME part.

top
UseXPkcs7
bool get_UseXPkcs7(void);
void put_UseXPkcs7(bool newVal);

If true, then the Content-Type header fields created by Chilkat will use "x-pkcs7" instead of simply "pkcs7" . For example:

Content-Type: multipart/signed;
	boundary="----=_NextPart_af8_0422_dbec3a60.7178e470";
	protocol="application/x-pkcs7-signature"; micalg=sha1

or

Content-Type: application/x-pkcs7-mime; name="smime.p7m"
If false, then the "pcks7" is used. For example:
Content-Type: multipart/signed;
	boundary="----=_NextPart_af8_0422_dbec3a60.7178e470";
	protocol="application/pkcs7-signature"; micalg=sha1

or

Content-Type: application/pkcs7-mime; name="smime.p7m"
The default value of this property is true, meaning that "x-" is used by default.

top
Utf8
bool get_Utf8(void);
void put_Utf8(bool newVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

top
VerboseLogging
bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
void get_Version(CkString &str);
const char *version(void);

Version of the component/library, such as "9.5.0.63"

top

Methods

AddContentLength
void AddContentLength(void);

Computes the size of the MIME body and adds a Content-Length header field with the computed value. If the MIME body is non-multipart, the Content-Length is just the size of the content. If the MIME is multipart, then the Content-Length is the sum of all the sub-parts. Calling this method more than once causes the Content-Length header to be re-computed and updated.

More Information and Examples
top
AddDecryptCert
bool AddDecryptCert(CkCert &cert);
Introduced in version 9.5.0.40

Makes a certificate available for decrypting if needed by methods that decrypt, such as UnwrapSecurity. This method may be called multiple times to make more than one certificate (and it's private key) available. Alternative methods for making certificates available are UseCertVault, AddPfxSourceFile, and AddPfxSourceData.

Returns true for success, false for failure.

top
AddDetachedSignature
bool AddDetachedSignature(CkCert &cert);

Signs the message using the certificate provided. If successful, the message is converted to "multipart/signed" and the original message will be contained in the first sub-part.

Returns true for success, false for failure.

top
AddDetachedSignature2
bool AddDetachedSignature2(CkCert &cert, bool transferHeaderFields);

Same as AddDetachedSignature, except an extra argument is provided to control whether header fields from the calling MIME object are transferred to the content part of the multipart/signed object. This method transforms the calling object into a multipart/signed MIME with two sub-parts. The first contains the original content of the calling object, and the second contains the digital signature.

Returns true for success, false for failure.

top
AddDetachedSignaturePk
bool AddDetachedSignaturePk(CkCert &cert, CkPrivateKey &privateKey);

Adds a detached signature using a certificate and it's associated private key. This method would be used when the private key is external to the certificate -- for example, if a PFX/P12 file is not used, but instead a pair of .cer and .pem files are used (one for the certificate and one for the associated private key).

Returns true for success, false for failure.

More Information and Examples
top
AddDetachedSignaturePk2
bool AddDetachedSignaturePk2(CkCert &cert, CkPrivateKey &privateKey, bool transferHeaderFields);

Same as AddDetachedSignaturePk, except an extra argument is provided to control whether header fields from the calling MIME object are transferred to the content part of the multipart/signed object. This method transforms the calling object into a multipart/signed MIME with two sub-parts. The first contains the original content of the calling object, and the second contains the digital signature.

Returns true for success, false for failure.

top
AddEncryptCert
bool AddEncryptCert(CkCert &cert);

Adds a certificate to the object's internal list of certificates to be used when the EncryptN method is called. (See the EncryptN method for more information.) The internal list may be cleared by calling ClearEncryptCerts.

Returns true for success, false for failure.

top
AddHeaderField
bool AddHeaderField(const char *name, const char *value);

Adds a header field to the MIME.

Returns true for success, false for failure.

More Information and Examples
top
AddPfxSourceData
bool AddPfxSourceData(CkByteData &pfxFileData, const char *pfxPassword);

Adds a PFX to the object's internal list of sources to be searched for certificates and private keys when decrypting . Multiple PFX sources can be added by calling this method once for each. (On the Windows operating system, the registry-based certificate stores are also automatically searched, so it is commonly not required to explicitly add PFX sources.)

The pfxFileData contains the bytes of a PFX file (also known as PKCS12 or .p12).

Returns true for success, false for failure.

top
AddPfxSourceFile
bool AddPfxSourceFile(const char *pfxFilePath, const char *password);

Adds a PFX file to the object's internal list of sources to be searched for certificates and private keys when decrypting. Multiple PFX files can be added by calling this method once for each. (On the Windows operating system, the registry-based certificate stores are also automatically searched, so it is commonly not required to explicitly add PFX sources.)

The pfxFilePath contains the bytes of a PFX file (also known as PKCS12 or .p12).

Returns true for success, false for failure.

top
AppendPart
bool AppendPart(CkMime &mime);

Appends a MIME message to the sub-parts of this message. Arbitrarily complex messages with unlimited nesting levels can be created. If the calling Mime object is not already multipart, it is automatically converted to multipart/mixed first.

Returns true for success, false for failure.

More Information and Examples
top
AppendPartFromFile
bool AppendPartFromFile(const char *filename);

Loads a file and creates a Mime message object using the file extension to determine the content type, and adds it as a sub-part to the calling object.

Returns true for success, false for failure.

top
AsnBodyToXml
bool AsnBodyToXml(CkString &outStr);
const char *asnBodyToXml(void);

When the body of a MIME part contains PKCS7 (ASN.1 in DER format, base64-encoded), this method can be used to convert the ASN.1 to an XML format for inspection. Here is an example of how an ASN.1 body might look:

Content-Type: application/x-pkcs7-mime;
	name="smime.p7m"; smime-type="signed-data"
Content-Transfer-Encoding: base64
Content-Disposition: attachment; filename="smime.p7m"

MIIXXAYJKoZIhvcNAQcCoIIXTTCCF0kCAQExCzAJBgUrDgMCGgUAMFoGCSqGSIb3DQEHAaBNBEtD
b250ZW50LVR5cGU6IHRleHQvcGxhaW4NCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDdiaXQN
Cg0KdGhpcyBpcyBhIHRlc3SgghI/MIIE3jCCA8agAwIBAgICAwEwDQYJKoZIhvcNAQEFBQAwYzEL
...
The XML produced would look something like this:
<?xml version="1.0" encoding="utf-8" ?>
<sequence>
    <oid>1.2.840.113549.1.7.2</oid>
    <contextSpecific tag="0" constructed="1">
        <sequence>
            <int>01</int>
            <set>
                <sequence>
                    <oid>1.3.14.3.2.26</oid>
                    <null />
                </sequence>
            </set>
            <sequence>
                <oid>1.2.840.113549.1.7.1</oid>
                <contextSpecific tag="0" constructed="1">
...

Returns true for success, false for failure.

top
ClearEncryptCerts
void ClearEncryptCerts(void);

Clears the internal list of certificates added by previous calls to the AddEncryptCert method. (See the EncryptN method for information about encrypting using multiple certificates.)

top
ContainsEncryptedParts
bool ContainsEncryptedParts(void);

Returns true if the MIME message contains encrypted parts.

Note: This method examines the MIME as-is. If UnwrapSecurity is called and it is successful, then the MIME should no longer contain encrypted parts, and this method would return 0.

Note: If a signed MIME message is then encrypted, then it is not possible to know that the MIME is both encrypted and signed until UnwrapSecurity is called. (In other words, it is not possible to know the contents of the encrypted MIME until it is decrypted.) Therefore, the ContainsSignedParts method would return false.

More Information and Examples
top
ContainsSignedParts
bool ContainsSignedParts(void);

Returns true if the MIME message contains signed parts.

Note: This method examines the MIME as-is. If UnwrapSecurity is called and it is successful, then the MIME should no longer contain signed parts, and this method would return 0.

Note: If a signed MIME message is then encrypted, then it is not possible to know that the MIME is both encrypted and signed until UnwrapSecurity is called. (In other words, it is not possible to know the contents of the encrypted MIME until it is decrypted.) Therefore, the ContainsSignedParts method would return false.

Note: The same concept also applies to opaque signatures, such as with the MIME produced by calling ConvertToSigned.

More Information and Examples
top
Convert8Bit
void Convert8Bit(void);

Changes the content-transfer-encoding to "base64" for all 8bit or binary MIME subparts. This allows for the MIME to be exported as a string via the GetMime method.

More Information and Examples
top
ConvertToMultipartAlt
bool ConvertToMultipartAlt(void);

Converts existing MIME to a multipart/alternative. This is accomplished by creating a new outermost multipart/alternative MIME part. The existing MIME is moved into the 1st (and only) sub-part of the new multipart/alternative enclosure. Header fields from the original top-level MIME part are transferred to the new top-level multipart/alternative header, except for Content-Type, Content-Transfer-Encoding, and Content-Disposition. For example, the following simple plain-text MIME is converted as follows:

Original:

MIME-Version: 1.0
Date: Sun, 11 Aug 2013 11:18:44 -0500
Message-ID: <D105FA9A2B5F34E253C6E255D58247D26F8BD724@CHILKAT13>
Content-Type: text/plain
Content-Transfer-Encoding: quoted-printable
X-Priority: 3 (Normal)
Subject: this is the subject.
From: "Chilkat Software" <support@chilkatsoft.com>
To: "Chilkat Sales" <sales@chilkatsoft.com>

This is the plain-text body.

After Converting:

MIME-Version: 1.0
Date: Sun, 11 Aug 2013 11:18:44 -0500
Message-ID: <D105FA9A2B5F34E253C6E255D58247D26F8BD724@CHILKAT13>
X-Priority: 3 (Normal)
Subject: this is the subject.
From: "Chilkat Software" <support@chilkatsoft.com>
To: "Chilkat Sales" <sales@chilkatsoft.com>
Content-Type: multipart/alternative;
	boundary="------------040101040804050401050400_.ALT"

--------------040101040804050401050400_.ALT
Content-Type: text/plain
Content-Transfer-Encoding: quoted-printable

This is the plain-text body.
--------------040101040804050401050400_.ALT--

Returns true for success, false for failure.

top
ConvertToMultipartMixed
bool ConvertToMultipartMixed(void);

Converts existing MIME to a multipart/mixed. This is accomplished by creating a new outermost multipart/mixed MIME part. The existing MIME is moved into the 1st (and only) sub-part of the new multipart/mixed enclosure. Header fields from the original top-level MIME part are transferred to the new top-level multipart/mixed header, except for Content-Type, Content-Transfer-Encoding, and Content-Disposition. For example, the following simple plain-text MIME is converted as follows:

Original:

MIME-Version: 1.0
Date: Sun, 11 Aug 2013 11:27:04 -0500
Message-ID: <B43DAF999B38BFE2C7240D86E691B8628D9D0BF4@CHILKAT13>
Content-Type: text/plain
Content-Transfer-Encoding: quoted-printable
X-Priority: 3 (Normal)
Subject: this is the subject.
From: "Chilkat Software" <support@chilkatsoft.com>
To: "Chilkat Sales" <sales@chilkatsoft.com>

This is the plain-text body.

After Converting:

MIME-Version: 1.0
Date: Sun, 11 Aug 2013 11:27:04 -0500
Message-ID: <B43DAF999B38BFE2C7240D86E691B8628D9D0BF4@CHILKAT13>
X-Priority: 3 (Normal)
Subject: this is the subject.
From: "Chilkat Software" <support@chilkatsoft.com>
To: "Chilkat Sales" <sales@chilkatsoft.com>
Content-Type: multipart/mixed;
	boundary="------------050508060709030908040207"

--------------050508060709030908040207
Content-Type: text/plain
Content-Transfer-Encoding: quoted-printable

This is the plain-text body.
--------------050508060709030908040207--

Returns true for success, false for failure.

More Information and Examples
top
ConvertToSigned
bool ConvertToSigned(CkCert &cert);

Digitally signs a MIME message. The MIME is converted to an application/x-pkcs7-mime which is a PKCS7 signature that includes both the original MIME message and the signature. This is different than AddDetachedSignature, where the signature is appended to the MIME.

Note: This is commonly referred to as an "opaque" signature.

Returns true for success, false for failure.

top
ConvertToSignedPk
bool ConvertToSignedPk(CkCert &cert, CkPrivateKey &privateKey);

Digitally signs the MIME to convert it to an "opaque" signed message using a certificate and it's associated private key. This method would be used when the private key is external to the certificate -- for example, if a PFX/P12 file is not used, but instead a pair of .cer and .pem files are used (one for the certificate and one for the associated private key).

Returns true for success, false for failure.

More Information and Examples
top
Decrypt
bool Decrypt(void);

Decrypts PKCS7 encrypted MIME (also known as S/MIME). Information about the certificates required for decryption is always embedded within PKCS7 encrypted MIME. This method will automatically find and use the certificate + private key required from three possible sources:

  1. PFX files that were provided in one or more calls to AddPfxSourceData or AddPfxSourceFile.
  2. Certificates found in an XML certificate vault provided by calling the UseCertVault method.
  3. (On Windows systems) Certificates found in the system's registry-based certificate stores.

Returns true for success, false for failure.

top
Decrypt2
bool Decrypt2(CkCert &cert, CkPrivateKey &privateKey);

The same as Decrypt, but useful when the certificate and private key are available in separate files (as opposed to a single file such as a .pfx/.p12).

Returns true for success, false for failure.

top
DecryptUsingCert
bool DecryptUsingCert(CkCert &cert);
Introduced in version 9.5.0.40

Decrypts PKCS7 encrypted MIME (also known as S/MIME) using a specific certificate.

Returns true for success, false for failure.

top
DecryptUsingPfxData
bool DecryptUsingPfxData(CkByteData &pfxData, const char *password);

Decrypts MIME using a specific PFX ( also known as PKCS12, which is a file format commonly used to store private keys with accompanying public key certificates, protected with a password-based symmetric key). This method allows the bytes of the PKCS12 file to be passed directly, thus allowing PKCS12's to be persisted and retrieved from non-file-based locations, such as in LDAP or a database.

Returns true for success, false for failure.

top
DecryptUsingPfxFile
bool DecryptUsingPfxFile(const char *pfxFilePath, const char *pfxPassword);

Decrypts MIME using a specific PFX file (also known as PKCS12) as the source for any required certificates and private keys. (Note: .pfx and .p12 files are both PKCS12 format.)

Returns true for success, false for failure.

More Information and Examples
top
Encrypt
bool Encrypt(CkCert &cert);

Encrypts the MIME to create PKCS7 encrypted MIME. A digital certificate (which always contains a public-key) is used to encrypt.

Returns true for success, false for failure.

top
EncryptN
bool EncryptN(void);

Encrypt MIME using any number of digital certificates. Each certificate to be used must first be added by calling AddEncryptCert (once per certificate). See the example code below:

Returns true for success, false for failure.

top
ExtractPartsToFiles
CkStringArray *ExtractPartsToFiles(const char *dirPath);

Recursively descends through the parts of a MIME message and extracts all parts having a filename to a file. The files are created in dirPath. Returns a (Ck)StringArray object containing the names of the files created. The filenames are obtained from the "filename" attribute of the content-disposition header. If a filename does not exist, then the MIME part is not saved to a file.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples
top
FindIssuer
CkCert *FindIssuer(CkCert &cert);

Finds and returns the issuer certificate. If the certificate is a root or self-issued, then the certificate returned is a copy of the caller certificate.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
GetBodyBd
bool GetBodyBd(CkBinData &binDat);
Introduced in version 9.5.0.67

Returns the body of the MIME message in a BinData object.

Returns true for success, false for failure.

top
GetBodyBinary
bool GetBodyBinary(CkByteData &outData);

Returns the body of the MIME message as a block of binary data. The body is automatically converted from its encoding type, such as base64 or quoted-printable, before being returned.

Returns true for success, false for failure.

top
GetBodyDecoded
bool GetBodyDecoded(CkString &outStr);
const char *getBodyDecoded(void);

Returns the body of the MIME message as a string. The body is automatically converted from its encoding type, such as base64 or quoted-printable, before being returned.

Returns true for success, false for failure.

top
GetBodyEncoded
bool GetBodyEncoded(CkString &outStr);
const char *getBodyEncoded(void);

Returns the body of the MIME message as a String. The body is explicitly not decoded from it's encoding type, so if it was represented in Base64, you will get the Base64 encoded body, as an example.

Returns true for success, false for failure.

top
GetEncryptCert
CkCert *GetEncryptCert(int index);

Returns the Nth certificate found when decrypting. The EncryptCerts property contains the number of certificates.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples
top
GetEntireBody
bool GetEntireBody(CkString &outStr);
const char *getEntireBody(void);

Returns the entire MIME body, including all sub-parts.

Returns true for success, false for failure.

More Information and Examples
top
GetEntireHead
bool GetEntireHead(CkString &outStr);
const char *getEntireHead(void);

Returns the MIME header.

Returns true for success, false for failure.

More Information and Examples
top
GetHeaderField
bool GetHeaderField(const char *fieldName, CkString &outStr);
const char *getHeaderField(const char *fieldName);

Returns the value of a MIME header field. fieldName is case-insensitive.

Returns true for success, false for failure.

More Information and Examples
top
GetHeaderFieldAttribute
bool GetHeaderFieldAttribute(const char *name, const char *attrName, CkString &outStr);
const char *getHeaderFieldAttribute(const char *name, const char *attrName);

Parses a MIME header field and returns the value of an attribute. MIME header fields w/ attributes are formatted like this:

Header-Name:  value;  attrName1="value1"; attrName2="value2"; ....  attrNameN="valueN"
Semi-colons separate attribute name=value pairs. The Content-Type header field often contains attributes. Here is an example:
Content-Type: multipart/signed;
	protocol="application/x-pkcs7-signature";
	micalg=SHA1;
	boundary="----=_NextPart_000_0000_01CB03E4.D0BAF010"
In the above example, to access the value of the "protocol" attribute, call GetHeaderFieldAttribute("Content-Type", "protocol");

Returns true for success, false for failure.

More Information and Examples
top
GetHeaderFieldName
bool GetHeaderFieldName(int index, CkString &outStr);
const char *getHeaderFieldName(int index);

Returns the Nth MIME header field name.

Returns true for success, false for failure.

top
GetHeaderFieldValue
bool GetHeaderFieldValue(int index, CkString &outStr);
const char *getHeaderFieldValue(int index);

Returns the Nth MIME header field value.

Returns true for success, false for failure.

top
GetMime
bool GetMime(CkString &outStr);
const char *getMime(void);

Returns a string containing the complete MIME message, including all sub-parts.

Returns true for success, false for failure.

top
GetMimeBd
bool GetMimeBd(CkBinData &bindat);
Introduced in version 9.5.0.62

Appends the MIME to a BinData object.

Returns true for success, false for failure.

More Information and Examples
top
GetMimeBytes
bool GetMimeBytes(CkByteData &outBytes);

Returns a byte array containing the complete MIME message, including all sub-parts.

Returns true for success, false for failure.

top
GetMimeSb
bool GetMimeSb(CkStringBuilder &sb);
Introduced in version 9.5.0.62

Appends the MIME to a StringBuilder object.

Returns true for success, false for failure.

More Information and Examples
top
GetPart
CkMime *GetPart(int index);

Returns the Nth sub-part of the MIME message. Indexing begins at 0.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
GetSignatureSigningTime
bool GetSignatureSigningTime(int index, SYSTEMTIME &outSysTime);
This method is deprecated. It will be removed in a future version.

Returns the signature signing date/time for the Nth signature. The number of signatures (i.e. signer certs) is indicated by the NumSignerCerts property. The HasSignatureSigningTime method may be called to determine if a signature timestamp is available. The index of the 1st signature signing time is 0.

Returns true for success, false for failure.

top
GetSignatureSigningTimeStr
bool GetSignatureSigningTimeStr(int index, CkString &outStr);
const char *getSignatureSigningTimeStr(int index);

The same as the GetSignatureSigningTime method, but returns tjhe date/time in RFC822 string format.

Returns true for success, false for failure.

top
GetSignerCert
CkCert *GetSignerCert(int index);

Returns the Nth digital certificate used to sign the MIME message. Indexing begins at 0.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

More Information and Examples
top
GetSignerCertChain
CkCertChain *GetSignerCertChain(int index);
Introduced in version 9.5.0.40

Returns the full certificate chain for the Nth certificate used to sign the MIME message. Indexing begins at 0.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
GetStructure
bool GetStructure(const char *fmt, CkString &outStr);
const char *getStructure(const char *fmt);
Introduced in version 9.5.0.56

Returns a string summarizing the MIME structure. The output format is specified by fmt and can be "text" or "xml".

Returns true for success, false for failure.

More Information and Examples
top
GetXml
bool GetXml(CkString &outStr);
const char *getXml(void);

Converts the MIME (or S/MIME) message to XML and returns the XML as a string.

Returns true for success, false for failure.

More Information and Examples
top
HasSignatureSigningTime
bool HasSignatureSigningTime(int index);

Returns true if the Nth signature included a timestamp that recorded the signing time. The number of signatures (i.e. signer certs) is indicated by the NumSignerCerts property. (In most cases, the number of signer certs is 1.) The signing time can be obtained via the GetSignatureSigningTime or GetSignatureSigningTimeStr methods. The index of the 1st signature signing time is 0.

top
IsApplicationData
bool IsApplicationData(void);

Return true if the MIME message contains application data, otherwise returns false.

top
IsAttachment
bool IsAttachment(void);

Return true if this MIME message is an attachment, otherwise returns false. A MIME message is considered an attachment if the Content-Disposition header field contains the value "attachment".

top
IsAudio
bool IsAudio(void);

Return true if the MIME message contains audio data, otherwise returns false.

top
IsEncrypted
bool IsEncrypted(void);

Returns true if the MIME message is PKCS7 encrypted, otherwise returns false.

top
IsHtml
bool IsHtml(void);

Return true if the MIME body is HTML, otherwise returns false.

top
IsImage
bool IsImage(void);

Return true if the MIME message contains image data, otherwise returns false.

top
IsMultipart
bool IsMultipart(void);

Return true if the MIME message is multipart (multipart/mixed, multipart/related, multipart/alternative, etc.), otherwise returns false.

top
IsMultipartAlternative
bool IsMultipartAlternative(void);

Return true if the MIME message is multipart/alternative, otherwise returns false.

top
IsMultipartMixed
bool IsMultipartMixed(void);

Return true if the MIME message is multipart/mixed, otherwise returns false.

top
IsMultipartRelated
bool IsMultipartRelated(void);

Return true if the MIME message is multipart/related, otherwise returns false.

top
IsPlainText
bool IsPlainText(void);

Return true if the MIME message body is plain text, otherwise returns false.

top
IsSigned
bool IsSigned(void);

Return true if the MIME message is PKCS7 digitally signed, otherwise returns false.

top
IsText
bool IsText(void);

Return true if the MIME message body is any text content type, such as text/plain, text/html, text/xml, etc., otherwise returns false.

top
IsUnlocked
bool IsUnlocked(void);

Returns true if the component is already unlocked, otherwise returns false.

top
IsVideo
bool IsVideo(void);

Return true if the MIME message contains video data, otherwise returns false.

top
IsXml
bool IsXml(void);

Return true if the MIME message body is XML, otherwise returns false.

top
LastJsonData
CkJsonObject *LastJsonData(void);
Introduced in version 9.5.0.69

Provides information about what transpired in the last method called on this object instance. For many methods, there is no information. However, for some methods, details about what occurred can be obtained by getting the LastJsonData right after the method call returns. For example, after calling UnwrapSecurity, the LastJsonData will return JSON with details about the algorithms used for signature verification and decryption.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
LoadMime
bool LoadMime(const char *mimeMsg);

Discards the current contents of the MIME object and loads a new MIME message from a string.

Returns true for success, false for failure.

top
LoadMimeBd
bool LoadMimeBd(CkBinData &bindat);
Introduced in version 9.5.0.62

Discards the current contents of the MIME object and loads a new MIME message from a BinData object.

Returns true for success, false for failure.

top
LoadMimeBytes
bool LoadMimeBytes(CkByteData &binData);

Loads a MIME document from an in-memory byte array.

Returns true for success, false for failure.

top
LoadMimeFile
bool LoadMimeFile(const char *fileName);

Discards the current contents of the MIME object and loads a new MIME message from a file.

Returns true for success, false for failure.

top
LoadMimeSb
bool LoadMimeSb(CkStringBuilder &sb);
Introduced in version 9.5.0.62

Discards the current contents of the MIME object and loads a new MIME message from a StringBuilder.

Returns true for success, false for failure.

More Information and Examples
top
LoadXml
bool LoadXml(const char *xml);

Converts XML to MIME and replaces the MIME object's contents with the converted XML.

Returns true for success, false for failure.

top
LoadXmlFile
bool LoadXmlFile(const char *fileName);

Converts XML to MIME and replaces the MIME object's contents with the converted XML.

Returns true for success, false for failure.

top
NewMessageRfc822
bool NewMessageRfc822(CkMime &mimeObject);

Clears the Mime object and initializes it such that the header contains a "content-type: message/rfc822" line and the body is the MIME text of the Mime object passed to the method.

Returns true for success, false for failure.

top
NewMultipartAlternative
bool NewMultipartAlternative(void);

Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/alternative message.

Returns true for success, false for failure.

More Information and Examples
top
NewMultipartMixed
bool NewMultipartMixed(void);

Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/mixed message.

Returns true for success, false for failure.

top
NewMultipartRelated
bool NewMultipartRelated(void);

Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/related message.

Returns true for success, false for failure.

More Information and Examples
top
RemoveHeaderField
void RemoveHeaderField(const char *fieldName, bool bAllOccurrences);

Removes a header field from the MIME header. If bAllOccurrences is true, then all occurrences of the header field are removed. Otherwise, only the 1st occurrence is removed.

More Information and Examples
top
RemovePart
bool RemovePart(int index);

Removes the Nth subpart from the MIME message.

Returns true for success, false for failure.

top
SaveBody
bool SaveBody(const char *filename);

Saves the MIME message body to a file. If the body is base64 or quoted-printable encoded, it is automatically decoded.

Returns true for success, false for failure.

top
SaveLastError
bool SaveLastError(const char *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top
SaveMime
bool SaveMime(const char *filename);

Saves the MIME message to a file, in MIME format. (This is the same as the .EML format used by Microsoft Outlook Express.)

Returns true for success, false for failure.

top
SaveXml
bool SaveXml(const char *filename);

Converts the MIME message to XML and saves to an XML file.

Returns true for success, false for failure.

top
SetBody
void SetBody(const char *str);

Sets the MIME body content to a text string.

More Information and Examples
top
SetBodyFromBinary
bool SetBodyFromBinary(CkByteData &binData);

Sets the MIME message body from a byte array.

Returns true for success, false for failure.

More Information and Examples
top
SetBodyFromEncoded
bool SetBodyFromEncoded(const char *encoding, const char *str);

Sets the MIME message body from a Base64 or Quoted-Printable encoded string.

Returns true for success, false for failure.

More Information and Examples
top
SetBodyFromFile
bool SetBodyFromFile(const char *fileName);

Sets the MIME message body from the contents of a file. Note: A MIME message consists of a header and a body. The body may itself be a MIME message that consists of a header and body, etc. This method loads the contents of a file into the body of a MIME message, without replacing the header.

The Content-Type and Content-Transfer-Encoding header fields are automatically updated to match the type of content loaded (based on file extension). If your application requires the MIME to have a specific Content-Type and/or Content-Transfer-Encoding, set the ContentType and Encoding properties after calling this method (not before).

Returns true for success, false for failure.

More Information and Examples
top
SetBodyFromHtml
bool SetBodyFromHtml(const char *str);

Sets the MIME message body from a string containing HTML. The Content-Type header is added or updated to the value "text/html".

If 8bit (non-us-ascii) characters are present, and if the Charset property was not previously set, then the "charset" attribute is automatically added to the Content-Type header using the default value of "utf-8". This can be changed at any time by setting the Charset property.

If the Encoding property was not previously set, then the Content-Transfer-Encoding header is automatically added. It will be set to "7bit" or "8bit" depending on whether the HTML body contains 8-bit non-us-ascii characters.

To set the MIME body with no intentional side-effects, use SetBody instead.

Returns true for success, false for failure.

top
SetBodyFromPlainText
bool SetBodyFromPlainText(const char *str);

Sets the MIME message body from a string containing plain-text. The Content-Type header is added or updated to the value "text/plain".

If 8bit (non-us-ascii) characters are present, and if the Charset property was not previously set, then the "charset" attribute is automatically added to the Content-Type header using the default value of "utf-8". This can be changed at any time by setting the Charset property.

If the Encoding property was not previously set, then the Content-Transfer-Encoding header is automatically added. It will be set to "7bit" or "8bit" depending on whether the plain-text body contains 8-bit non-us-ascii characters.

To set the MIME body with no intentional side-effects, use SetBody instead.

Returns true for success, false for failure.

top
SetBodyFromXml
bool SetBodyFromXml(const char *str);

Sets the MIME message body from a string containing XML. The Content-Type header is added or updated to the value "text/xml".

If 8bit (non-us-ascii) characters are present, and if the Charset property was not previously set, then the "charset" attribute is automatically added to the Content-Type header using the default value of "utf-8". This can be changed at any time by setting the Charset property.

If the Encoding property was not previously set, then the Content-Transfer-Encoding header is automatically added. It will be set to "7bit" or "8bit" depending on whether the plain-text body contains 8-bit non-us-ascii characters.

To set the MIME body with no intentional side-effects, use SetBody instead.

Returns true for success, false for failure.

More Information and Examples
top
SetCSP
bool SetCSP(CkCsp &csp);

(Only applies to the Microsoft Windows OS) Sets the Cryptographic Service Provider (CSP) to be used for encryption / signing, or decryption / signature verification.

This is not commonly used becaues the default Microsoft CSP is typically appropriate. One instance where SetCSP is necessary is when using the Crypto-Pro CSP for the GOST R 34.10-2001 and GOST R 34.10-94 providers.

Returns true for success, false for failure.

top
SetHeaderField
bool SetHeaderField(const char *name, const char *value);

Adds or replaces a MIME message header field. If the field already exists, it is automatically replaced. Otherwise it is added. Pass zero-length value to remove the header field.

Returns true for success, false for failure.

More Information and Examples
top
SetVerifyCert
bool SetVerifyCert(CkCert &cert);

Allows a certificate to be explicitly specified for verifying a signature.

Returns true for success, false for failure.

top
UnlockComponent
bool UnlockComponent(const char *unlockCode);

Unlocks the component allowing for the full functionality to be used. If this method unexpectedly returns false, examine the contents of the LastErrorText property to determine the reason for failure.

Returns true for success, false for failure.

top
UnwrapSecurity
bool UnwrapSecurity(void);

Decrypts and/or verifies all digital signatures contained within the MIME message, and returns true if all decryptions and verifications succeeded. Otherwise returns false. After unwrapping, the information regarding security and certificates can be obtained by the methods GetSignerCert and GetEncryptCert, and the properties NumEncryptCerts and NumSignerCerts.

The MIME is restored to the original structure/content prior to all signing and/or encryption.

The difference between UnwrapSecurity and methods such as Verify or Decrypt is that UnwrapSecurity will recursively traverse the MIME to decrypt and/or verify all parts. Also, UnwrapSecurity will unwrap layers until no further encrypted/signed content is found. For example, if a MIME message was encrypted and then subsequently signed, then UnwrapSecurity will verify and unwrap the detached signature/signed-data layer, and then decrypt the "enveloped data".

Returns true for success, false for failure.

More Information and Examples
top
UrlEncodeBody
void UrlEncodeBody(const char *charset);

URL encodes the MIME body. The charset is important. For example, consider this MIME:

Content-Type: text/plain
Content-Transfer-Encoding: 8bit

Société
If the charset is set to "utf-8", then the following is produced:
Content-Type: text/plain
Content-Transfer-Encoding: 8bit

Soci%C3%A9t%C3%A9
However, if the charset is set to "ansi", then the following is the result:
Content-Type: text/plain
Content-Transfer-Encoding: 8bit

Soci%E9t%E9

top
UseCertVault
bool UseCertVault(CkXmlCertVault &vault);

Adds an XML certificate vault to the object's internal list of sources to be searched for certificates and private keys when encrypting/decrypting or signing/verifying. Unlike the AddPfxSourceData and AddPfxSourceFile methods, only a single XML certificate vault can be used. If UseCertVault is called multiple times, only the last certificate vault will be used, as each call to UseCertVault will replace the certificate vault provided in previous calls.

Returns true for success, false for failure.

top
Verify
bool Verify(void);

Verifies PKCS7 signed MIME and "unwraps" the signature. The MIME is restored to the original structure that it would have originally had prior to signing. The Verify method works with both detached signatures, as well as opaque/attached signatures.

A PKCS7 signature usually embeds both the signing certificate with its public key. Therefore, it is usually possible to verify a signature without the need to already have the certificate installed. If the signature does not embed the certificate, the Verify method will automatically locate and use the certificate if it was correctly pre-installed on the computer.

Returns true for success, false for failure.

top