ChilkatMime ActiveX Reference
ChilkatMime
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
(Visual Basic 6.0)
Dim obj As New ChilkatMime
(ASP)
set obj = Server.CreateObject("Chilkat.Mime")
(VBScript)
set obj = CreateObject("Chilkat.Mime")
(Delphi)
obj := TChilkatMime.Create(Self);
(FoxPro)
loObject = CreateObject('Chilkat.Mime')
(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Mime', @obj OUT
(Javascript)
var obj = new ActiveXObject("Chilkat.Mime");
Properties
Boundary As String
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. (ASP) Example Code: Create a Multipart-Mixed MIME Message with Auto-Generated Boundary and with Explicitly Set Boundary (VB6) Example Code: Create a Multipart-Mixed MIME Message with Auto-Generated Boundary and with Explicitly Set Boundary (Delphi) Example Code: Create a Multipart-Mixed MIME Message with Auto-Generated Boundary and with Explicitly Set Boundary (FoxPro) Example Code: Create a Multipart-Mixed MIME Message with Auto-Generated Boundary and with Explicitly Set Boundary (PHP using ActiveX) Example Code: Create a Multipart-Mixed MIME Message with Auto-Generated Boundary and with Explicitly Set Boundary (VBScript) Example Code: Create a Multipart-Mixed MIME Message with Auto-Generated Boundary and with Explicitly Set Boundary
Charset As String
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".(ASP) Example Code: Demonstrates the effect of setting the Charset property. (VB6) Example Code: Demonstrates the effect of setting the Charset property. (Delphi) Example Code: Demonstrates the effect of setting the Charset property. (FoxPro) Example Code: Demonstrates the effect of setting the Charset property. (PHP using ActiveX) Example Code: Demonstrates the effect of setting the Charset property. (VBScript) Example Code: Demonstrates the effect of setting the Charset property.
ContentType As String
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".
CurrentDateTime As String (read-only)
Returns the current date/time in RFC 822 format.
Disposition As String
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".
Encoding As String
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".
Filename As String
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".
LastErrorHtml As String (read-only)
Error information in HTML format for the last method called.
LastErrorText As String (read-only)
Error information in plain-text format for the last method called.
LastErrorXml As String (read-only)
Error information in XML format for the last method called.
Micalg As String
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.
Name As String
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".
NumEncryptCerts As Long (read-only)
The number of certificates found when decrypting S/MIME. This property is set after UnwrapSecurity is called.
NumHeaderFields As Long (read-only)
The number of header fields. Header field names and values can be retrieved by index (starting at 0) by calling GetHeaderFieldName and GetHeaderFieldValue.
NumParts As Long (read-only)
The number of sub-parts contained within this message. Each sub-part is a complete Chilkat MIME message itself.
NumSignerCerts As Long (read-only)
The number of certificates found when verifying signature(s). This property is set after UnwrapSecurity is called.
Pkcs7CryptAlg As String
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".
Pkcs7KeyLength As Long
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.
Protocol As String
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".
SigningHashAlg As String
Selects the underlying hash algorithm used when creating signed (PKCS7) MIME. Possible values are "sha1", "sha256", "sha384", "sha512", "md5", and "md2".
UnwrapExtras As Long
Controls whether extra (informative) header fields are added to the MIME message when unwrapping security.
UseMmDescription As Long
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. (ASP) Example Code: Create a Multipart-Mixed MIME Message (shows the difference when UseMmDescription is on/off). (VB6) Example Code: Create a Multipart-Mixed MIME Message (shows the difference when UseMmDescription is on/off). (Delphi) Example Code: Create a Multipart-Mixed MIME Message (shows the difference when UseMmDescription is on/off). (FoxPro) Example Code: Create a Multipart-Mixed MIME Message (shows the difference when UseMmDescription is on/off). (PHP using ActiveX) Example Code: Create a Multipart-Mixed MIME Message (shows the difference when UseMmDescription is on/off). (VBScript) Example Code: Create a Multipart-Mixed MIME Message (shows the difference when UseMmDescription is on/off).
VerboseLogging As Long
If 1, increases the amount of information available in LastErrorText (or LastErrorXml / LastErrorHtml). The default is 0.
Version As String (read-only)
The version, such as "1.0.0".
Methods
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. (ASP) Add Content-Length Header to a MIME Message (VB6) Add Content-Length Header to a MIME Message (Delphi) Add Content-Length Header to a MIME Message (FoxPro) Add Content-Length Header to a MIME Message (PHP using ActiveX) Add Content-Length Header to a MIME Message (VBScript) Add Content-Length Header to a MIME Message
AddDetachedSignature(cert As ChilkatCert) As Long
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. (ASP) Example Code: Create PKCS7 Detached Signature (S/MIME) (VB6) Example Code: Create PKCS7 Detached Signature (S/MIME) (Delphi) Example Code: Create PKCS7 Detached Signature (S/MIME) (FoxPro) Example Code: Create PKCS7 Detached Signature (S/MIME) (PHP using ActiveX) Example Code: Create PKCS7 Detached Signature (S/MIME) (VBScript) Example Code: Create PKCS7 Detached Signature (S/MIME) (ASP) Example: Add S/MIME Signature using PFX (VB6) Example: Add S/MIME Signature using PFX (Delphi) Example: Add S/MIME Signature using PFX (FoxPro) Example: Add S/MIME Signature using PFX (PHP using ActiveX) Example: Add S/MIME Signature using PFX (VBScript) Example: Add S/MIME Signature using PFX
AddDetachedSignature2(cert As ChilkatCert, transferHeaderFields As Long) As Long
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.
AddDetachedSignaturePk(cert As ChilkatCert, key As PrivateKey) As Long
To be documented soon.
AddDetachedSignaturePk2(cert As ChilkatCert, key As PrivateKey, transferHeaderFields As Long) As Long
To be documented soon.
AddEncryptCert(cert As ChilkatCert) As Long
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.
AddHeaderField(fieldName As String, fieldValue As String)
Adds a header field to the MIME.
AddPfxSourceData(pfxFileData As Variant, pfxPassword As String) As Long
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.
AddPfxSourceFile(pfxFilePath As String, password As String) As Long
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.
AppendPart(iMime As ChilkatMime)
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.
AppendPartFromFile(fileName As String) As Long
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.
AsnBodyToXml() As String
To be documented soon. Returns a null on failure
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.)
ContainsEncryptedParts() As Long
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.
ContainsSignedParts() As Long
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.
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.
ConvertToMultipartAlt() As Long
To be documented soon. Returns 1 for success, 0 for failure.
ConvertToMultipartMixed() As Long
To be documented soon. Returns 1 for success, 0 for failure.
ConvertToSigned(cert As ChilkatCert) As Long
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. (ASP) Example Code: Create PKCS7 Attached/Opaque Signature (S/MIME) (VB6) Example Code: Create PKCS7 Attached/Opaque Signature (S/MIME) (Delphi) Example Code: Create PKCS7 Attached/Opaque Signature (S/MIME) (FoxPro) Example Code: Create PKCS7 Attached/Opaque Signature (S/MIME) (PHP using ActiveX) Example Code: Create PKCS7 Attached/Opaque Signature (S/MIME) (VBScript) Example Code: Create PKCS7 Attached/Opaque Signature (S/MIME)
ConvertToSignedPk(cert As ChilkatCert, key As PrivateKey) As Long
To be documented soon. Returns 1 for success, 0 for failure.
Decrypt() As Long
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. (ASP) Example Code: PKCS7 Decrypt MIME (VB6) Example Code: PKCS7 Decrypt MIME (Delphi) Example Code: PKCS7 Decrypt MIME (FoxPro) Example Code: PKCS7 Decrypt MIME (PHP using ActiveX) Example Code: PKCS7 Decrypt MIME (VBScript) Example Code: PKCS7 Decrypt MIME
Decrypt2(cert As ChilkatCert, key As PrivateKey) As Long
To be documented soon. Returns 1 for success, 0 for failure.
DecryptUsingPfxData(pfxData As Variant, password As String) As Long
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. (ASP) Example Code: PKCS7 Decrypt Using .pfx or .p12 Data (VB6) Example Code: PKCS7 Decrypt Using .pfx or .p12 Data (Delphi) Example Code: PKCS7 Decrypt Using .pfx or .p12 Data (FoxPro) Example Code: PKCS7 Decrypt Using .pfx or .p12 Data (PHP using ActiveX) Example Code: PKCS7 Decrypt Using .pfx or .p12 Data (VBScript) Example Code: PKCS7 Decrypt Using .pfx or .p12 Data
DecryptUsingPfxFile(pfxFilePath As String, pfxPassword As String) As Long
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. (ASP) PKCS7 Decrypt Using .pfx or .p12 File (VB6) PKCS7 Decrypt Using .pfx or .p12 File (Delphi) PKCS7 Decrypt Using .pfx or .p12 File (FoxPro) PKCS7 Decrypt Using .pfx or .p12 File (PHP using ActiveX) PKCS7 Decrypt Using .pfx or .p12 File (VBScript) PKCS7 Decrypt Using .pfx or .p12 File
Encrypt(cert As ChilkatCert) As Long
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. (ASP) Example Code: PKCS7 Encrypt MIME (VB6) Example Code: PKCS7 Encrypt MIME (Delphi) Example Code: PKCS7 Encrypt MIME (FoxPro) Example Code: PKCS7 Encrypt MIME (PHP using ActiveX) Example Code: PKCS7 Encrypt MIME (VBScript) Example Code: PKCS7 Encrypt MIME
EncryptN() As Long
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. (ASP) Example: PKCS7 Encrypt using Multiple Certificates (VB6) Example: PKCS7 Encrypt using Multiple Certificates (Delphi) Example: PKCS7 Encrypt using Multiple Certificates (FoxPro) Example: PKCS7 Encrypt using Multiple Certificates (PHP using ActiveX) Example: PKCS7 Encrypt using Multiple Certificates (VBScript) Example: PKCS7 Encrypt using Multiple Certificates
ExtractPartsToFiles(dirPath As String) As CkStringArray
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 (ASP) Extract Files from MIME (VB6) Extract Files from MIME (Delphi) Extract Files from MIME (FoxPro) Extract Files from MIME (PHP using ActiveX) Extract Files from MIME (VBScript) Extract Files from MIME
GetBodyBinary() As Variant
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 a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements. (ASP) Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file) (VB6) Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file) (Delphi) Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file) (FoxPro) Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file) (PHP using ActiveX) Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file) (VBScript) Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file)
GetBodyDecoded() As String
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 null on failure (ASP) Example Code: GetBodyEncoded / GetBodyDecoded (VB6) Example Code: GetBodyEncoded / GetBodyDecoded (Delphi) Example Code: GetBodyEncoded / GetBodyDecoded (FoxPro) Example Code: GetBodyEncoded / GetBodyDecoded (PHP using ActiveX) Example Code: GetBodyEncoded / GetBodyDecoded (VBScript) Example Code: GetBodyEncoded / GetBodyDecoded (ASP) Example Code: MIME Body vs. Sub-Parts (VB6) Example Code: MIME Body vs. Sub-Parts (Delphi) Example Code: MIME Body vs. Sub-Parts (FoxPro) Example Code: MIME Body vs. Sub-Parts (PHP using ActiveX) Example Code: MIME Body vs. Sub-Parts (VBScript) Example Code: MIME Body vs. Sub-Parts
GetBodyEncoded() As String
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 null on failure (ASP) Example Code: GetBodyEncoded / GetBodyDecoded (VB6) Example Code: GetBodyEncoded / GetBodyDecoded (Delphi) Example Code: GetBodyEncoded / GetBodyDecoded (FoxPro) Example Code: GetBodyEncoded / GetBodyDecoded (PHP using ActiveX) Example Code: GetBodyEncoded / GetBodyDecoded (VBScript) Example Code: GetBodyEncoded / GetBodyDecoded (ASP) Example Code: MIME Body vs. Sub-Parts (VB6) Example Code: MIME Body vs. Sub-Parts (Delphi) Example Code: MIME Body vs. Sub-Parts (FoxPro) Example Code: MIME Body vs. Sub-Parts (PHP using ActiveX) Example Code: MIME Body vs. Sub-Parts (VBScript) Example Code: MIME Body vs. Sub-Parts
GetEncryptCert(index As Long) As ChilkatCert
Returns the Nth certificate found when decrypting. The EncryptCerts property contains the number of certificates.
GetEntireBody() As String
Returns the entire MIME body, including all sub-parts. Returns a null on failure
GetEntireHead() As String
Returns the MIME header. Returns a null on failure
GetHeaderField(fieldName As String) As String
Returns the value of a MIME header field. fieldName is case-insensitive. Returns a null on failure
GetHeaderFieldAttribute(name As String, attrName As String) As String
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 null on failure (ASP) Example Code: Parse MIME Header Fields (VB6) Example Code: Parse MIME Header Fields (Delphi) Example Code: Parse MIME Header Fields (FoxPro) Example Code: Parse MIME Header Fields (PHP using ActiveX) Example Code: Parse MIME Header Fields (VBScript) Example Code: Parse MIME Header Fields
GetHeaderFieldName(index As Long) As String
Returns the Nth MIME header field name. Returns a null on failure
GetHeaderFieldValue(index As Long) As String
Returns the Nth MIME header field value. Returns a null on failure
GetMime() As String
Returns a string containing the complete MIME message, including all sub-parts. Returns a null on failure
GetMimeBytes() As Variant
Returns a byte array containing the complete MIME message, including all sub-parts. Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.
GetPart(index As Long) As ChilkatMime
Returns the Nth sub-part of the MIME message. Indexing begins at 0.
GetSignatureSigningTime(index As Long) As Date
To be documented soon.
GetSignerCert(index As Long) As ChilkatCert
Returns the Nth digital certificate used to sign the MIME message. Indexing begins at 0.
GetXml() As String
Converts the MIME (or S/MIME) message to XML and returns the XML as a string. Returns a null on failure
HasSignatureSigningTime(index As Long) As Long
To be documented soon.
IsApplicationData() As Long
Return 1 if the MIME message contains application data, otherwise returns 0.
IsAttachment() As Long
Return 1 if this MIME message is an attachment, otherwise returns 0.
IsAudio() As Long
Return 1 if the MIME message contains audio data, otherwise returns 0.
IsEncrypted() As Long
Returns 1 if the MIME message is PKCS7 encrypted, otherwise returns 0.
IsHtml() As Long
Return 1 if the MIME body is HTML, otherwise returns 0.
IsImage() As Long
Return 1 if the MIME message contains image data, otherwise returns 0.
IsMultipart() As Long
Return 1 if the MIME message is multipart (multipart/mixed, multipart/related, multipart/alternative, etc.), otherwise returns 0.
IsMultipartAlternative() As Long
Return 1 if the MIME message is multipart/alternative, otherwise returns 0.
IsMultipartMixed() As Long
Return true if the MIME message is multipart/mixed, otherwise returns 0.
IsMultipartRelated() As Long
Return 1 if the MIME message is multipart/related, otherwise returns 0.
IsPlainText() As Long
Return 1 if the MIME message body is plain text, otherwise returns 0.
IsSigned() As Long
Return 1 if the MIME message is PKCS7 digitally signed, otherwise returns 0.
IsText() As Long
Return 1 if the MIME message body is any text content type, such as text/plain, text/html, text/xml, etc., otherwise returns 0.
IsVideo() As Long
Return 1 if the MIME message contains video data, otherwise returns 0.
IsXml() As Long
Return 1 if the MIME message body is XML, otherwise returns 0.
LoadMime(mimeMsg As String) As Long
Discards the current contents of the MIME object and loads a new MIME message from a string.
LoadMimeBytes(binaryMime As Variant)
Loads a MIME document from an in-memory byte array.
LoadMimeFile(fileName As String) As Long
Discards the current contents of the MIME object and loads a new MIME message from a file. Returns 1 for success, 0 for failure.
LoadXml(xml As String) As Long
Converts XML to MIME and replaces the MIME object's contents with the converted XML.
LoadXmlFile(fileName As String) As Long
Converts XML to MIME and replaces the MIME object's contents with the converted XML. Returns 1 for success, 0 for failure.
NewMessageRfc822(iMime As ChilkatMime)
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.
NewMultipartAlternative()
Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/alternative message.
NewMultipartMixed()
Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/mixed message. (ASP) Example Code: Create a Multipart-Mixed MIME Message (VB6) Example Code: Create a Multipart-Mixed MIME Message (Delphi) Example Code: Create a Multipart-Mixed MIME Message (FoxPro) Example Code: Create a Multipart-Mixed MIME Message (PHP using ActiveX) Example Code: Create a Multipart-Mixed MIME Message (VBScript) Example Code: Create a Multipart-Mixed MIME Message
NewMultipartRelated()
Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/related message.
RemoveHeaderField(fieldName As String, bAllOccurances As Long)
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.
RemovePart(index As Long)
Removes the Nth subpart from the MIME message.
SaveBody(filename As String) As Long
Saves the MIME message body to a file. If the body is base64 or quoted-printable encoded, it is automatically decoded. (ASP) Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file) (VB6) Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file) (Delphi) Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file) (FoxPro) Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file) (PHP using ActiveX) Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file) (VBScript) Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file)
SaveLastError(filename As String) As Long
Saves the last error information to an XML formatted file.
SaveMime(filename As String) As Long
Saves the MIME message to a file, in MIME format. (This is the same as the .EML format used by Microsoft Outlook Express.)
SaveXml(filename As String) As Long
Converts the MIME message to XML and saves to an XML file.
SetBody(str As String)
Sets the MIME body content to a text string. (ASP) Example Code: MIME SetBody (VB6) Example Code: MIME SetBody (Delphi) Example Code: MIME SetBody (FoxPro) Example Code: MIME SetBody (PHP using ActiveX) Example Code: MIME SetBody (VBScript) Example Code: MIME SetBody
SetBodyFromBinary(binaryData As Variant)
Sets the MIME message body from a byte array.
SetBodyFromEncoded(encoding As String, bodyText As String)
Sets the MIME message body from a Base64 or Quoted-Printable encoded string.
SetBodyFromFile(filename As String) As Long
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).
SetBodyFromHtml(bodyText As String)
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. (ASP) Example Code: Create MIME Containing HTML (VB6) Example Code: Create MIME Containing HTML (Delphi) Example Code: Create MIME Containing HTML (FoxPro) Example Code: Create MIME Containing HTML (PHP using ActiveX) Example Code: Create MIME Containing HTML (VBScript) Example Code: Create MIME Containing HTML
SetBodyFromPlainText(bodyText As String)
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. (ASP) Example Code: Create MIME Containing Plain-Text (VB6) Example Code: Create MIME Containing Plain-Text (Delphi) Example Code: Create MIME Containing Plain-Text (FoxPro) Example Code: Create MIME Containing Plain-Text (PHP using ActiveX) Example Code: Create MIME Containing Plain-Text (VBScript) Example Code: Create MIME Containing Plain-Text
SetBodyFromXml(bodyText As String)
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. (ASP) Example Code: Create MIME Containing XML (VB6) Example Code: Create MIME Containing XML (Delphi) Example Code: Create MIME Containing XML (FoxPro) Example Code: Create MIME Containing XML (PHP using ActiveX) Example Code: Create MIME Containing XML (VBScript) Example Code: Create MIME Containing XML
SetCSP(iCsp As ChilkatCSP) As Long
(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.
SetHeaderField(name As String, value As String)
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.
SetVerifyCert(iCert As ChilkatCert)
Allows a certificate to be explicitly specified for verifying a signature.
UnlockComponent(unlockCode As String) As Long
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.
UnwrapSecurity() As Long
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.
UrlEncodeBody(charset As String)
To be documented soon.
Verify() As Long
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. (ASP) Example Code: Verify and Unwrap PCKS7 Signed MIME (VB6) Example Code: Verify and Unwrap PCKS7 Signed MIME (Delphi) Example Code: Verify and Unwrap PCKS7 Signed MIME (FoxPro) Example Code: Verify and Unwrap PCKS7 Signed MIME (PHP using ActiveX) Example Code: Verify and Unwrap PCKS7 Signed MIME (VBScript) Example Code: Verify and Unwrap PCKS7 Signed MIME
|