TChilkatMime Delphi Reference
TChilkatMime
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.
Object Creation
var
obj: IChilkatMime;
...
begin
obj := CoChilkatMime.Create();
Properties
property Boundary: WideString
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.
property Charset: WideString
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".
property ContentType: WideString
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".
property CurrentDateTime: WideString readonly
Returns the current date/time in RFC 822 format.
property Disposition: WideString
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".
property Encoding: WideString
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".
property Filename: WideString
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".
property LastErrorHtml: WideString readonly
Error information in HTML format for the last method called.
property LastErrorText: WideString readonly
Error information in plain-text format for the last method called.
property LastErrorXml: WideString readonly
Error information in XML format for the last method called.
property Micalg: WideString
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.
property Name: WideString
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".
property NumEncryptCerts: Integer readonly
The number of certificates found when decrypting S/MIME. This property is set after UnwrapSecurity is called.
property NumHeaderFields: Integer readonly
The number of header fields. Header field names and values can be retrieved by index (starting at 0) by calling GetHeaderFieldName and GetHeaderFieldValue.
property NumParts: Integer readonly
The number of sub-parts contained within this message. Each sub-part is a complete Chilkat MIME message itself.
property NumSignerCerts: Integer readonly
The number of certificates found when verifying signature(s). This property is set after UnwrapSecurity is called.
property Pkcs7CryptAlg: WideString
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".
property Pkcs7KeyLength: Integer
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.
property Protocol: WideString
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".
property SigningHashAlg: WideString
Selects the underlying hash algorithm used when creating signed (PKCS7) MIME. Possible values are "sha1", "sha256", "sha384", "sha512", "md5", and "md2".
property UnwrapExtras: Integer
Controls whether extra (informative) header fields are added to the MIME message when unwrapping security.
property UseMmDescription: Integer
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.
property VerboseLogging: Integer
If 1, increases the amount of information available in LastErrorText (or LastErrorXml / LastErrorHtml). The default is 0.
property Version: WideString readonly
The version, such as "1.0.0".
Methods
procedure 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.
function AddDetachedSignature(cert: TChilkatCert): Integer;
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 1 for success, 0 for failure.
function AddDetachedSignature2(cert: TChilkatCert, transferHeaderFields: Integer): Integer;
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 1 for success, 0 for failure.
function AddDetachedSignaturePk(cert: TChilkatCert, key: TPrivateKey): Integer;
To be documented soon.
function AddDetachedSignaturePk2(cert: TChilkatCert, key: TPrivateKey, transferHeaderFields: Integer): Integer;
To be documented soon.
function AddEncryptCert(cert: TChilkatCert): Integer;
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 1 for success, 0 for failure.
procedure AddHeaderField(fieldName: WideString, fieldValue: WideString);
Adds a header field to the MIME.
function AddPfxSourceData(pfxFileData: OleVariant, pfxPassword: WideString): Integer;
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 1 for success, 0 for failure.
function AddPfxSourceFile(pfxFilePath: WideString, password: WideString): Integer;
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 ARG1 contains the bytes of a PFX file (also known as PKCS12 or .p12). Returns 1 for success, 0 for failure.
procedure AppendPart(iMime: TChilkatMime);
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.
function AppendPartFromFile(fileName: WideString): Integer;
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 1 for success, 0 for failure.
function AsnBodyToXml(): WideString;
To be documented soon. Returns a zero-length WideString on failure
procedure 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.)
function ContainsEncryptedParts(): Integer;
Returns 1 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 0.
function ContainsSignedParts(): Integer;
Returns 1 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 0.
Note: The same concept also applies to opaque signatures, such as with the MIME produced by calling ConvertToSigned.
procedure 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.
function ConvertToMultipartAlt(): Integer;
To be documented soon. Returns 1 for success, 0 for failure.
function ConvertToMultipartMixed(): Integer;
To be documented soon. Returns 1 for success, 0 for failure.
function ConvertToSigned(cert: TChilkatCert): Integer;
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 1 for success, 0 for failure.
function ConvertToSignedPk(cert: TChilkatCert, key: TPrivateKey): Integer;
To be documented soon. Returns 1 for success, 0 for failure.
function Decrypt(): Integer;
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 1 for success, 0 for failure.
function Decrypt2(cert: TChilkatCert, key: TPrivateKey): Integer;
To be documented soon. Returns 1 for success, 0 for failure.
function DecryptUsingPfxData(pfxData: OleVariant, password: WideString): Integer;
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 1 for success, 0 for failure.
function DecryptUsingPfxFile(pfxFilePath: WideString, pfxPassword: WideString): Integer;
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 1 for success, 0 for failure.
function Encrypt(cert: TChilkatCert): Integer;
Encrypts the MIME to create PKCS7 encrypted MIME. A digital certificate (which always contains a public-key) is used to encrypt. Returns 1 for success, 0 for failure.
function EncryptN(): Integer;
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 1 for success, 0 for failure.
function ExtractPartsToFiles(dirPath: WideString): TCkStringArray;
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
function GetBodyBinary(): OleVariant;
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 a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.
function GetBodyDecoded(): WideString;
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 a zero-length WideString on failure
function GetBodyEncoded(): WideString;
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 a zero-length WideString on failure
function GetEncryptCert(index: Integer): TChilkatCert;
Returns the Nth certificate found when decrypting. The EncryptCerts property contains the number of certificates.
function GetEntireBody(): WideString;
Returns the entire MIME body, including all sub-parts. Returns a zero-length WideString on failure
function GetEntireHead(): WideString;
Returns the MIME header. Returns a zero-length WideString on failure
function GetHeaderField(fieldName: WideString): WideString;
Returns the value of a MIME header field. fieldName is case-insensitive. Returns a zero-length WideString on failure
function GetHeaderFieldAttribute(name: WideString, attrName: WideString): WideString;
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 a zero-length WideString on failure
function GetHeaderFieldName(index: Integer): WideString;
Returns the Nth MIME header field name. Returns a zero-length WideString on failure
function GetHeaderFieldValue(index: Integer): WideString;
Returns the Nth MIME header field value. Returns a zero-length WideString on failure
function GetMime(): WideString;
Returns a string containing the complete MIME message, including all sub-parts. Returns a zero-length WideString on failure
function GetMimeBytes(): OleVariant;
Returns a byte array containing the complete MIME message, including all sub-parts. Returns a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.
function GetPart(index: Integer): TChilkatMime;
Returns the Nth sub-part of the MIME message. Indexing begins at 0.
function GetSignatureSigningTime(index: Integer): TDateTime;
To be documented soon.
function GetSignerCert(index: Integer): TChilkatCert;
Returns the Nth digital certificate used to sign the MIME message. Indexing begins at 0.
function GetXml(): WideString;
Converts the MIME (or S/MIME) message to XML and returns the XML as a string. Returns a zero-length WideString on failure
function HasSignatureSigningTime(index: Integer): Integer;
To be documented soon.
function IsApplicationData(): Integer;
Return 1 if the MIME message contains application data, otherwise returns 0.
function IsAttachment(): Integer;
Return 1 if this MIME message is an attachment, otherwise returns 0.
function IsAudio(): Integer;
Return 1 if the MIME message contains audio data, otherwise returns 0.
function IsEncrypted(): Integer;
Returns 1 if the MIME message is PKCS7 encrypted, otherwise returns 0.
function IsHtml(): Integer;
Return 1 if the MIME body is HTML, otherwise returns 0.
function IsImage(): Integer;
Return 1 if the MIME message contains image data, otherwise returns 0.
function IsMultipart(): Integer;
Return 1 if the MIME message is multipart (multipart/mixed, multipart/related, multipart/alternative, etc.), otherwise returns 0.
function IsMultipartAlternative(): Integer;
Return 1 if the MIME message is multipart/alternative, otherwise returns 0.
function IsMultipartMixed(): Integer;
Return true if the MIME message is multipart/mixed, otherwise returns 0.
function IsMultipartRelated(): Integer;
Return 1 if the MIME message is multipart/related, otherwise returns 0.
function IsPlainText(): Integer;
Return 1 if the MIME message body is plain text, otherwise returns 0.
function IsSigned(): Integer;
Return 1 if the MIME message is PKCS7 digitally signed, otherwise returns 0.
function IsText(): Integer;
Return 1 if the MIME message body is any text content type, such as text/plain, text/html, text/xml, etc., otherwise returns 0.
function IsVideo(): Integer;
Return 1 if the MIME message contains video data, otherwise returns 0.
function IsXml(): Integer;
Return 1 if the MIME message body is XML, otherwise returns 0.
function LoadMime(mimeMsg: WideString): Integer;
Discards the current contents of the MIME object and loads a new MIME message from a string.
procedure LoadMimeBytes(binaryMime: OleVariant);
Loads a MIME document from an in-memory byte array.
function LoadMimeFile(fileName: WideString): Integer;
Discards the current contents of the MIME object and loads a new MIME message from a file. Returns 1 for success, 0 for failure.
function LoadXml(xml: WideString): Integer;
Converts XML to MIME and replaces the MIME object's contents with the converted XML.
function LoadXmlFile(fileName: WideString): Integer;
Converts XML to MIME and replaces the MIME object's contents with the converted XML. Returns 1 for success, 0 for failure.
procedure NewMessageRfc822(iMime: TChilkatMime);
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.
procedure NewMultipartAlternative();
Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/alternative message.
procedure NewMultipartMixed();
Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/mixed message.
procedure NewMultipartRelated();
Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/related message.
procedure RemoveHeaderField(fieldName: WideString, bAllOccurances: Integer);
Removes a header field from the MIME header. If bAllOccurances is 1, then all occurances of the header field are removed. Otherwise, only the 1st occurance is removed.
procedure RemovePart(index: Integer);
Removes the Nth subpart from the MIME message.
function SaveBody(filename: WideString): Integer;
Saves the MIME message body to a file. If the body is base64 or quoted-printable encoded, it is automatically decoded.
function SaveLastError(filename: WideString): Integer;
Saves the last error information to an XML formatted file.
function SaveMime(filename: WideString): Integer;
Saves the MIME message to a file, in MIME format. (This is the same as the .EML format used by Microsoft Outlook Express.)
function SaveXml(filename: WideString): Integer;
Converts the MIME message to XML and saves to an XML file.
procedure SetBody(str: WideString);
Sets the MIME body content to a text string.
procedure SetBodyFromBinary(binaryData: OleVariant);
Sets the MIME message body from a byte array.
procedure SetBodyFromEncoded(encoding: WideString, bodyText: WideString);
Sets the MIME message body from a Base64 or Quoted-Printable encoded string.
function SetBodyFromFile(filename: WideString): Integer;
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).
procedure SetBodyFromHtml(bodyText: WideString);
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.
procedure SetBodyFromPlainText(bodyText: WideString);
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.
procedure SetBodyFromXml(bodyText: WideString);
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.
function SetCSP(iCsp: TChilkatCSP): Integer;
(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.
procedure SetHeaderField(name: WideString, value: WideString);
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.
procedure SetVerifyCert(iCert: TChilkatCert);
Allows a certificate to be explicitly specified for verifying a signature.
function UnlockComponent(unlockCode: WideString): Integer;
Unlocks the component allowing for the full functionality to be used. If this method unexpectedly returns 0, examine the contents of the LastErrorText property to determine the reason for failure. Returns 1 for success, 0 for failure.
function UnwrapSecurity(): Integer;
Decrypts and/or verifies all digital signatures contained within the MIME message, and returns 1 if all decryptions and verifications succeeded. Otherwise returns 0. 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 1 for success, 0 for failure.
procedure UrlEncodeBody(charset: WideString);
To be documented soon.
function Verify(): Integer;
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 1 for success, 0 for failure.
|