CkMime C++ Class Reference (Visual C++)
CkMime
Chilkat MIME allows you to easily create and manipulate MIME and S/MIME messages from within your applications. ("Chilkat MIME" may be referred to as "Chilkat S/MIME" on some chilkatsoft.com web pages. They are the same product.) The Chilkat MIME license also includes the Chilkat DKIM component/class/libs for creating and verifying DKIM / DomainKey signatures.
Properties
void get_Boundary(CkString &str);
void put_Boundary(const char *newVal);
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. Example Code: Create a Multipart-Mixed MIME Message with Auto-Generated Boundary and with Explicitly Set Boundary
void get_Charset(CkString &sb);
void put_Charset(const char *newVal);
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".Example Code: Demonstrates the effect of setting the Charset property.
void get_ContentType(CkString &str);
void put_ContentType(const char *newVal);
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".
void get_CurrentDateTime(CkString &str);
Returns the current date/time in RFC 822 format.
void get_Disposition(CkString &str);
void put_Disposition(const char *newVal);
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".
void get_Encoding(CkString &str);
void put_Encoding(const char *newVal);
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".
void get_Filename(CkString &str);
void put_Filename(const char *newVal);
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".
void LastErrorHtml(CkString &str);
Error information in HTML format for the last method called.
void LastErrorText(CkString &str);
Error information in plain-text format for the last method called.
void LastErrorXml(CkString &str);
Error information in XML format for the last method called.
void get_Micalg(CkString &str);
void put_Micalg(const char *newVal);
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.
void get_Name(CkString &str);
void put_Name(const char *newVal);
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".
long get_NumEncryptCerts(void);
The number of certificates found when decrypting S/MIME. This property is set after UnwrapSecurity is called.
long 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.
long get_NumParts(void);
The number of sub-parts contained within this message. Each sub-part is a complete Chilkat MIME message itself.
long get_NumSignerCerts(void);
The number of certificates found when verifying signature(s). This property is set after UnwrapSecurity is called.
void get_Pkcs7CryptAlg(CkString &str);
void put_Pkcs7CryptAlg(const char *newVal);
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".
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.
void get_Protocol(CkString &str);
void put_Protocol(const char *newVal);
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".
void get_SigningHashAlg(CkString &str);
void put_SigningHashAlg(const char *newVal);
Selects the underlying hash algorithm used when creating signed (PKCS7) MIME. Possible values are "sha1", "sha256", "sha384", "sha512", "md5", and "md2".
bool get_UnwrapExtras(void);
void put_UnwrapExtras(bool newVal);
Controls whether extra (informative) header fields are added to the MIME message when unwrapping security.
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. Example Code: Create a Multipart-Mixed MIME Message (shows the difference when UseMmDescription is on/off).
bool get_Utf8(void) const;
void put_Utf8(bool b);
When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.
bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);
If true, increases the amount of information available in LastErrorText (or LastErrorXml / LastErrorHtml). The default is false.
void get_Version(CkString &str);
The version, such as "1.0.0".
Methods
void AddContentLength();
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. Add Content-Length Header to a MIME Message
bool AddDetachedSignature(const 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. Example Code: Create PKCS7 Detached Signature (S/MIME) Example: Add S/MIME Signature using PFX
bool AddDetachedSignature2(const 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.
bool AddDetachedSignaturePk(const CkCert & cert, const CkPrivateKey & privateKey);
To be documented soon.
bool AddDetachedSignaturePk2(const CkCert & cert, const CkPrivateKey & privateKey, bool transferHeaderFields);
To be documented soon.
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.
bool AddHeaderField(const char * name, const char * value);
Adds a header field to the MIME.
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. The component will search PFX source, as well as Windows registry-based certificate stores.
The pfxFileData contains the bytes of a PFX file (also known as PKCS12 or .p12). Returns true for success, false for failure.
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. The component will search PFX source, as well as Windows registry-based certificate stores.
Note: A .pfx file is also known as PKCS12, or .p12. Returns true for success, false for failure.
bool AppendPart(const 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.
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.
bool AsnBodyToXml(CkString & outStr);
To be documented soon. Returns true for success, false for failure.
void ClearEncryptCerts();
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.)
bool ContainsEncryptedParts();
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.
bool ContainsSignedParts();
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.
void Convert8Bit();
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.
void ConvertToMultipartAlt();
To be documented soon. Returns true for success, false for failure.
void ConvertToMultipartMixed();
To be documented soon. Returns true for success, false for failure.
bool ConvertToSigned(const 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. Example Code: Create PKCS7 Attached/Opaque Signature (S/MIME)
bool ConvertToSignedPk(const CkCert & cert, const CkPrivateKey & privateKey);
To be documented soon. Returns true for success, false for failure.
bool Decrypt();
If the MIME is PKCS7 encrypted, this method can decrypt. Information about the certificates required for decryption is always embedded within a PKCS7 enveloped (i.e. encrypted) message. This method will automatically use this information to locate the certificate + private key in Windows-based registry stores. If the cert + private key was previously installed, such as from a PFX, then the Decrypt method should be able to find it.
If the required cert + private key was NOT previously installed, then it is possible to use PFX files directly. See the AddPfxSourceData and AddPfxSourceFile methods for more information. (Also, see the example linked below.) Returns true for success, false for failure. Example Code: PKCS7 Decrypt MIME
bool Decrypt2(const CkCert & cert, const CkPrivateKey & privateKey);
To be documented soon. Returns true for success, false for failure.
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.
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. PKCS7 Decrypt Using .pfx or .p12 File
bool Encrypt(const 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. Example Code: PKCS7 Encrypt MIME
bool EncryptN();
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. Example: PKCS7 Encrypt using Multiple Certificates
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. Returns a null reference on failure Extract Files from MIME
bool GetBodyBinary(CkByteData & db);
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.
bool GetBodyDecoded(CkString & decodedBody);
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. Example Code: GetBodyEncoded / GetBodyDecoded Example Code: MIME Body vs. Sub-Parts
bool GetBodyEncoded(CkString & encodedBody);
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. Example Code: GetBodyEncoded / GetBodyDecoded Example Code: MIME Body vs. Sub-Parts
CkCert * GetEncryptCert(long index);
Returns the Nth certificate found when decrypting. The EncryptCerts property contains the number of certificates.
void GetEntireBody(CkString & str);
Returns the entire MIME body, including all sub-parts. Returns true for success, false for failure.
void GetEntireHead(CkString & str);
Returns the MIME header. Returns true for success, false for failure.
bool GetHeaderField(const char * fieldName, CkString & value);
Returns the value of a MIME header field. fieldName is case-insensitive. Returns true for success, false for failure.
bool GetHeaderFieldAttribute(const char * name, const char * attrName, CkString & outStr);
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. Example Code: Parse MIME Header Fields
bool GetHeaderFieldName(int index, CkString & fieldName);
Returns the Nth MIME header field name. Returns true for success, false for failure.
bool GetHeaderFieldValue(int index, CkString & fieldValue);
Returns the Nth MIME header field value. Returns true for success, false for failure.
bool GetMime(CkString & mime);
Returns a string containing the complete MIME message, including all sub-parts. Returns true for success, false for failure.
bool GetMimeBytes(CkByteData & outBytes);
Returns a byte array containing the complete MIME message, including all sub-parts.
CkMime * GetPart(long index);
Returns the Nth sub-part of the MIME message. Indexing begins at 0.
bool GetSignatureSigningTime(int index, SYSTEMTIME & sysTime);
To be documented soon.
CkCert * GetSignerCert(long index);
Returns the Nth digital certificate used to sign the MIME message. Indexing begins at 0.
bool GetXml(CkString & xml);
Converts the MIME (or S/MIME) message to XML and returns the XML as a string. Returns true for success, false for failure.
bool HasSignatureSigningTime(int index);
To be documented soon.
bool IsApplicationData();
Return true if the MIME message contains application data, otherwise returns false.
bool IsAttachment();
Return true if this MIME message is an attachment, otherwise returns false.
bool IsAudio();
Return true if the MIME message contains audio data, otherwise returns false.
bool IsEncrypted();
Returns true if the MIME message is PKCS7 encrypted, otherwise returns false.
bool IsHtml();
Return true if the MIME body is HTML, otherwise returns false.
bool IsImage();
Return true if the MIME message contains image data, otherwise returns false.
bool IsMultipart();
Return true if the MIME message is multipart (multipart/mixed, multipart/related, multipart/alternative, etc.), otherwise returns false.
bool IsMultipartAlternative();
Return true if the MIME message is multipart/alternative, otherwise returns false.
bool IsMultipartMixed();
Return true if the MIME message is multipart/mixed, otherwise returns false.
bool IsMultipartRelated();
Return true if the MIME message is multipart/related, otherwise returns false.
bool IsPlainText();
Return true if the MIME message body is plain text, otherwise returns false.
bool IsSigned();
Return true if the MIME message is PKCS7 digitally signed, otherwise returns false.
bool IsText();
Return true if the MIME message body is any text content type, such as text/plain, text/html, text/xml, etc., otherwise returns false.
bool IsUnlocked();
Returns true if the component is already unlocked, otherwise returns false.
bool IsVideo();
Return true if the MIME message contains video data, otherwise returns false.
bool IsXml();
Return true if the MIME message body is XML, otherwise returns false.
bool LoadMime(const char * mimeMsg);
Discards the current contents of the MIME object and loads a new MIME message from a string.
bool LoadMimeBytes(CkByteData & bData);
Loads a MIME document from an in-memory byte array.
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.
bool LoadXml(const char * xml);
Converts XML to MIME and replaces the MIME object's contents with the converted XML.
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.
bool NewMessageRfc822(const 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.
bool NewMultipartAlternative();
Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/alternative message.
bool NewMultipartMixed();
Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/mixed message. Example Code: Create a Multipart-Mixed MIME Message
bool NewMultipartRelated();
Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/related message.
void RemoveHeaderField(const char * fieldName, bool bAllOccurances);
Removes a header field from the MIME header. If bAllOccurances is true, then all occurances of the header field are removed. Otherwise, only the 1st occurance is removed.
bool RemovePart(int index);
Removes the Nth subpart from the MIME message.
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.
bool SaveLastError(const char * filename);
Saves the last error information to an XML formatted file.
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.)
bool SaveXml(const char * filename);
Converts the MIME message to XML and saves to an XML file.
void SetBody(const char * str);
Sets the MIME body content to a text string. Example Code: MIME SetBody
bool SetBodyFromBinary(const CkByteData & dbuf);
Sets the MIME message body from a byte array.
bool SetBodyFromEncoded(const char * encoding, const char * str);
Sets the MIME message body from a Base64 or Quoted-Printable encoded string.
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).
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. Example Code: Create MIME Containing HTML
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. Example Code: Create MIME Containing Plain-Text
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. Example Code: Create MIME Containing XML
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.
void SetVerifyCert(const CkCert * cert);
Allows a certificate to be explicitly specified for verifying a signature.
void SetVerifyCert(const CkCert & cert);
Allows a certificate to be explicitly specified for verifying a signature.
CkEmail * ToEmailObject();
Returns the MIME message converted to a CkEmail object. Returns a null reference on failure
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.
bool UnwrapSecurity();
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.
void UrlEncodeBody(const char * charset);
To be documented soon.
bool Verify();
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. Example Code: Verify and Unwrap PCKS7 Signed MIME
const char * asnBodyToXml();
To be documented soon.
const char * bodyDecoded();
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.
const char * bodyEncoded();
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.
const char * boundary();
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. Example Code: Create a Multipart-Mixed MIME Message with Auto-Generated Boundary and with Explicitly Set Boundary
const char * charset();
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".Example Code: Demonstrates the effect of setting the Charset property.
const char * contentType();
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".
const char * currentDateTime();
Returns the current date/time in RFC 822 format.
const char * disposition();
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".
const char * encoding();
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".
const char * entireBody();
Returns the entire MIME body, including all sub-parts.
const char * entireHead();
Returns the MIME header.
const char * filename();
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".
const char * getBodyDecoded();
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. Example Code: GetBodyEncoded / GetBodyDecoded Example Code: MIME Body vs. Sub-Parts
const char * getBodyEncoded();
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. Example Code: GetBodyEncoded / GetBodyDecoded Example Code: MIME Body vs. Sub-Parts
const char * getEntireBody();
Returns the entire MIME body, including all sub-parts.
const char * getEntireHead();
Returns the MIME header.
const char * getHeaderField(const char * fieldName);
Returns the value of a MIME header field. fieldName is case-insensitive.
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");Example Code: Parse MIME Header Fields
const char * getHeaderFieldName(int index);
Returns the Nth MIME header field name.
const char * getHeaderFieldValue(int index);
Returns the Nth MIME header field value.
const char * getMime();
Returns a string containing the complete MIME message, including all sub-parts.
const char * getXml();
Converts the MIME (or S/MIME) message to XML and returns the XML as a string.
const char * header(const char * name);
Returns the content of a MIME header field. The "fieldName" is case-insensitive, and if the MIME header field does not exist, an empty string is returned.
const char * headerName(int index);
Returns the Nth MIME header field name.
const char * headerValue(int index);
Returns the Nth MIME header field value.
const char * lastErrorHtml();
Error information in HTML format for the last method called.
const char * lastErrorText();
Error information in plain-text format for the last method called.
const char * lastErrorXml();
Error information in XML format for the last method called.
const char * micalg();
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.
const char * mime();
Returns a string containing the complete MIME message, including all sub-parts.
const char * name();
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".
const char * pkcs7CryptAlg();
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".
const char * protocol();
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".
const char * signingHashAlg();
Selects the underlying hash algorithm used when creating signed (PKCS7) MIME. Possible values are "sha1", "sha256", "sha384", "sha512", "md5", and "md2".
const char * xml();
Converts the MIME (or S/MIME) message to XML and returns the XML as a string.
|