Chilkat C# Mime Class Reference
Mime
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
(C#)
Chilkat.Mime obj = new Chilkat.Mime();
(VB.NET)
Dim obj As New Chilkat.Mime()
Properties
public string Boundary {get; set; }
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
public string Charset {get; set; }
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.
public string ContentType {get; set; }
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".
public string CurrentDateTime {get; }
Returns the current date/time in RFC 822 format.
public string Disposition {get; set; }
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".
public string Encoding {get; set; }
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".
public string Filename {get; set; }
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".
public string LastErrorHtml {get; }
Error information in HTML format for the last method called.
public string LastErrorText {get; }
Error information in plain-text format for the last method called.
public string LastErrorXml {get; }
Error information in XML format for the last method called.
public string Micalg {get; set; }
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.
public string Name {get; set; }
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".
public int NumEncryptCerts {get; }
The number of certificates found when decrypting S/MIME. This property is set after UnwrapSecurity is called.
public int NumHeaderFields {get; }
The number of header fields. Header field names and values can be retrieved by index (starting at 0) by calling GetHeaderFieldName and GetHeaderFieldValue.
public int NumParts {get; }
The number of sub-parts contained within this message. Each sub-part is a complete Chilkat MIME message itself.
public int NumSignerCerts {get; }
The number of certificates found when verifying signature(s). This property is set after UnwrapSecurity is called.
public string Pkcs7CryptAlg {get; set; }
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".
public int Pkcs7KeyLength {get; set; }
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.
public string Protocol {get; set; }
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".
public string SigningHashAlg {get; set; }
Selects the underlying hash algorithm used when creating signed (PKCS7) MIME. Possible values are "sha1", "sha256", "sha384", "sha512", "md5", and "md2".
public bool UnwrapExtras {get; set; }
Controls whether extra (informative) header fields are added to the MIME message when unwrapping security.
public bool UseMmDescription {get; set; }
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).
public bool VerboseLogging {get; set; }
If true, increases the amount of information available in LastErrorText (or LastErrorXml / LastErrorHtml). The default is false.
public string Version {get; }
The version, such as "1.0.0".
Methods
public 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
public bool AddDetachedSignature(Cert 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
public bool AddDetachedSignature2(Cert 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.
public bool AddDetachedSignaturePk(Cert cert, PrivateKey privateKey);
To be documented soon.
public bool AddDetachedSignaturePk2(Cert cert, PrivateKey privateKey, bool transferHeaderFields);
To be documented soon.
public bool AddEncryptCert(Cert 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.
public bool AddHeaderField(string name, string value);
Adds a header field to the MIME.
public bool AddPfxSourceData(byte[] pfxFileData, string 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.
public bool AddPfxSourceFile(string pfxFilePath, string 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.
public bool AppendPart(Mime 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.
public bool AppendPartFromFile(string 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.
public string AsnBodyToXml();
To be documented soon. Returns a null on failure
public 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.)
public 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.
public 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.
public 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.
public bool ConvertToMultipartAlt();
To be documented soon. Returns true for success, false for failure.
public bool ConvertToMultipartMixed();
To be documented soon. Returns true for success, false for failure.
public bool ConvertToSigned(Cert 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)
public bool ConvertToSignedPk(Cert cert, PrivateKey privateKey);
To be documented soon. Returns true for success, false for failure.
public 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
public bool Decrypt2(Cert cert, PrivateKey privateKey);
To be documented soon. Returns true for success, false for failure.
public bool DecryptUsingPfxData(byte[] pfxData, string 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.
public bool DecryptUsingPfxFile(string pfxFilePath, string 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
public bool Encrypt(Cert 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
public 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
public StringArray ExtractPartsToFiles(string 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
public byte[] GetBodyBinary();
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 an empty byte array on failure Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file)
public string 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. Returns a null on failure Example Code: GetBodyEncoded / GetBodyDecoded Example Code: MIME Body vs. Sub-Parts
public string 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. Returns a null on failure Example Code: GetBodyEncoded / GetBodyDecoded Example Code: MIME Body vs. Sub-Parts
public Cert GetEncryptCert(int index);
Returns the Nth certificate found when decrypting. The EncryptCerts property contains the number of certificates.
public string GetEntireBody();
Returns the entire MIME body, including all sub-parts. Returns a null on failure
public string GetEntireHead();
Returns the MIME header. Returns a null on failure
public string GetHeaderField(string fieldName);
Returns the value of a MIME header field. fieldName is case-insensitive. Returns a null on failure
public string GetHeaderFieldAttribute(string name, string attrName);
Parses a MIME header field and returns the value of an attribute. MIME header fields w/ attributes are formatted like this:
Header-Name: value; attrName1="value1"; attrName2="value2"; .... attrNameN="valueN"
Semi-colons separate attribute name=value pairs. The Content-Type header field often contains attributes. Here is an example:
Content-Type: multipart/signed;
protocol="application/x-pkcs7-signature";
micalg=SHA1;
boundary="----=_NextPart_000_0000_01CB03E4.D0BAF010"
In the above example, to access the value of the "protocol" attribute, call GetHeaderFieldAttribute("Content-Type", "protocol");Returns a null on failure Example Code: Parse MIME Header Fields
public string GetHeaderFieldName(int index);
Returns the Nth MIME header field name. Returns a null on failure
public string GetHeaderFieldValue(int index);
Returns the Nth MIME header field value. Returns a null on failure
public string GetMime();
Returns a string containing the complete MIME message, including all sub-parts. Returns a null on failure
public byte[] GetMimeBytes();
Returns a byte array containing the complete MIME message, including all sub-parts. Returns an empty byte array on failure
public Mime GetPart(int index);
Returns the Nth sub-part of the MIME message. Indexing begins at 0.
public DateTime GetSignatureSigningTime(int index);
To be documented soon.
public Cert GetSignerCert(int index);
Returns the Nth digital certificate used to sign the MIME message. Indexing begins at 0.
public string GetXml();
Converts the MIME (or S/MIME) message to XML and returns the XML as a string. Returns a null on failure
public bool HasSignatureSigningTime(int index);
To be documented soon.
public bool IsApplicationData();
Return true if the MIME message contains application data, otherwise returns false.
public bool IsAttachment();
Return true if this MIME message is an attachment, otherwise returns false.
public bool IsAudio();
Return true if the MIME message contains audio data, otherwise returns false.
public bool IsEncrypted();
Returns true if the MIME message is PKCS7 encrypted, otherwise returns false.
public bool IsHtml();
Return true if the MIME body is HTML, otherwise returns false.
public bool IsImage();
Return true if the MIME message contains image data, otherwise returns false.
public bool IsMultipart();
Return true if the MIME message is multipart (multipart/mixed, multipart/related, multipart/alternative, etc.), otherwise returns false.
public bool IsMultipartAlternative();
Return true if the MIME message is multipart/alternative, otherwise returns false.
public bool IsMultipartMixed();
Return true if the MIME message is multipart/mixed, otherwise returns false.
public bool IsMultipartRelated();
Return true if the MIME message is multipart/related, otherwise returns false.
public bool IsPlainText();
Return true if the MIME message body is plain text, otherwise returns false.
public bool IsSigned();
Return true if the MIME message is PKCS7 digitally signed, otherwise returns false.
public 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.
public bool IsUnlocked();
Returns true if the component is already unlocked, otherwise returns false.
public bool IsVideo();
Return true if the MIME message contains video data, otherwise returns false.
public bool IsXml();
Return true if the MIME message body is XML, otherwise returns false.
public bool LoadMime(string mimeMsg);
Discards the current contents of the MIME object and loads a new MIME message from a string.
public bool LoadMimeBinary(byte[] binData);
Loads a MIME document from an in-memory byte array. Returns true for success, false for failure.
public bool LoadMimeFile(string 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.
public bool LoadXml(string xml);
Converts XML to MIME and replaces the MIME object's contents with the converted XML.
public bool LoadXmlFile(string fileName);
Converts XML to MIME and replaces the MIME object's contents with the converted XML. Returns true for success, false for failure.
public bool NewMessageRfc822(Mime 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.
public 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.
public 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
public 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.
public void RemoveHeaderField(string 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.
public bool RemovePart(int index);
Removes the Nth subpart from the MIME message.
public bool SaveBody(string filename);
Saves the MIME message body to a file. If the body is base64 or quoted-printable encoded, it is automatically decoded. Example Code: Parse MIME to get Binary Data (such as GIF, JPG, or any binary file)
public bool SaveLastError(string filename);
Saves the last error information to an XML formatted file.
public bool SaveMime(string filename);
Saves the MIME message to a file, in MIME format. (This is the same as the .EML format used by Microsoft Outlook Express.)
public bool SaveXml(string filename);
Converts the MIME message to XML and saves to an XML file.
public void SetBody(string str);
Sets the MIME body content to a text string. Example Code: MIME SetBody
public bool SetBodyFromBinary(byte[] binData);
Sets the MIME message body from a byte array.
public bool SetBodyFromEncoded(string encoding, string str);
Sets the MIME message body from a Base64 or Quoted-Printable encoded string.
public bool SetBodyFromFile(string 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).
public bool SetBodyFromHtml(string 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
public bool SetBodyFromPlainText(string 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
public bool SetBodyFromXml(string 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
public bool SetCSP(Csp csp);
Sets the encryption and digital signature preferences for this message. The CSP object will control the Cryptographic Service Provider used, the key container within the CSP to be used, and the encryption/hash algorithms.
public bool SetHeaderField(string name, string 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.
public void SetVerifyCert(Cert cert);
Allows a certificate to be explicitly specified for verifying a signature.
public bool UnlockComponent(string 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.
public 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.
public void UrlEncodeBody(string charset);
To be documented soon.
public 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
|