CkMime Ruby Reference Documentation
CkMime
Current Version: 10.1.0
Chilkat MIME allows you to easily create and manipulate MIME and S/MIME messages from within your applications.
Object Creation
obj = Chilkat::CkMime.new()
Properties
Boundary
# ckStr is a CkString
mime.get_Boundary(ckStr);
strVal = mime.boundary();
mime.put_Boundary(strVal);
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.
Charset
# ckStr is a CkString
mime.get_Charset(ckStr);
strVal = mime.charset();
mime.put_Charset(strVal);
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".
CmsOptions
# ckStr is a CkString
mime.get_CmsOptions(ckStr);
strVal = mime.cmsOptions();
mime.put_CmsOptions(strVal);
A JSON string for controlling extra CMS (PKCS7) signature and validation options.
topContentType
# ckStr is a CkString
mime.get_ContentType(ckStr);
strVal = mime.contentType();
mime.put_ContentType(strVal);
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
# ckStr is a CkString
mime.get_CurrentDateTime(ckStr);
strVal = mime.currentDateTime();
DebugLogFilePath
# ckStr is a CkString
mime.get_DebugLogFilePath(ckStr);
strVal = mime.debugLogFilePath();
mime.put_DebugLogFilePath(strVal);
If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.
This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
Disposition
# ckStr is a CkString
mime.get_Disposition(ckStr);
strVal = mime.disposition();
mime.put_Disposition(strVal);
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
# ckStr is a CkString
mime.get_Encoding(ckStr);
strVal = mime.encoding();
mime.put_Encoding(strVal);
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: base64then the value of the Encoding property is "base64".
Filename
# ckStr is a CkString
mime.get_Filename(ckStr);
strVal = mime.filename();
mime.put_Filename(strVal);
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
# ckStr is a CkString
mime.get_LastErrorHtml(ckStr);
strVal = mime.lastErrorHtml();
Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastErrorText
# ckStr is a CkString
mime.get_LastErrorText(ckStr);
strVal = mime.lastErrorText();
Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
LastErrorXml
# ckStr is a CkString
mime.get_LastErrorXml(ckStr);
strVal = mime.lastErrorXml();
Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastMethodSuccess
boolVal = mime.get_LastMethodSuccess();
mime.put_LastMethodSuccess(boolVal);
Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:
- Any method that returns a string.
- Any method returning a Chilkat object, binary bytes, or a date/time.
- Any method returning a standard boolean status value where success = true and failure = false.
- Any method returning an integer where failure is defined by a return value less than zero.
Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topMicalg
# ckStr is a CkString
mime.get_Micalg(ckStr);
strVal = mime.micalg();
mime.put_Micalg(strVal);
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.
topName
# ckStr is a CkString
mime.get_Name(ckStr);
strVal = mime.name();
mime.put_Name(strVal);
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
intVal = mime.get_NumEncryptCerts();
The number of certificates found when decrypting S/MIME. This property is set after UnwrapSecurity is called.
topNumHeaderFields
intVal = mime.get_NumHeaderFields();
The number of header fields. Header field names and values can be retrieved by index (starting at 0) by calling GetHeaderFieldName and GetHeaderFieldValue.
topNumParts
intVal = mime.get_NumParts();
MIME messages are composed of parts in a tree structure. The NumParts property contains the number of direct children. To traverse an entire MIME tree, one would recursively descend the tree structure by iterating from 0 to NumParts-1, calling GetPart to get each direct child MIME object. The traversal would continue by iterating over each child's parts, and so on.
topNumSignerCerts
intVal = mime.get_NumSignerCerts();
The number of certificates found when verifying signature(s). This property is set after UnwrapSecurity is called.
topOaepHash
# ckStr is a CkString
mime.get_OaepHash(ckStr);
strVal = mime.oaepHash();
mime.put_OaepHash(strVal);
Selects the hash algorithm for use within OAEP padding when encrypting MIME using RSAES-OAEP. The valid choices are "sha1", "sha256", "sha384", "sha512",
OaepMgfHash
# ckStr is a CkString
mime.get_OaepMgfHash(ckStr);
strVal = mime.oaepMgfHash();
mime.put_OaepMgfHash(strVal);
Selects the MGF hash algorithm for use within OAEP padding when encrypting MIME using RSAES-OAEP. The valid choices are "sha1", "sha256", "sha384", "sha512", The default is "sha1".
topOaepPadding
boolVal = mime.get_OaepPadding();
mime.put_OaepPadding(boolVal);
Selects the RSA encryption scheme when encrypting MIME. The default value is false, which selects RSAES_PKCS1-V1_5. If set to true, then RSAES_OAEP is used.
Pkcs7CryptAlg
# ckStr is a CkString
mime.get_Pkcs7CryptAlg(ckStr);
strVal = mime.pkcs7CryptAlg();
mime.put_Pkcs7CryptAlg(strVal);
When the MIME is encrypted (using PKCS7 public-key encryption), this selects the underlying symmetric encryption algorithm. Possible values are: "aes", "des", "3des", and "rc2". The default value is "aes".
Pkcs7KeyLength
intVal = mime.get_Pkcs7KeyLength();
mime.put_Pkcs7KeyLength(intVal);
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.
topProtocol
# ckStr is a CkString
mime.get_Protocol(ckStr);
strVal = mime.protocol();
mime.put_Protocol(strVal);
The value of the "protocol" attribute of the Content-Type header field. For example, if the Content-Type header is this:
Content-Type: multipart/signed; protocol="application/x-pkcs7-signature"; micalg=sha1; boundary="------------ms000908010507020408060303"then the value of the Protocol property is "application/x-pkcs7-signature". top
SigningAlg
# ckStr is a CkString
mime.get_SigningAlg(ckStr);
strVal = mime.signingAlg();
mime.put_SigningAlg(strVal);
Selects the signature algorithm to be used when creating signed (PKCS7/CMS) MIME. The default value is "PKCS1-v1_5". This can be set to "RSASSA-PSS" (or simply "pss") to use the RSASSA-PSS signature scheme.
Note: This property only applies when signing with an RSA private key. It does not apply for ECC or DSA private keys.
Also: This property does not get set when a signature is verified. It is only used to specify the algorithm when creating a signature. The LastJsonData method can be used to get information about the verified signature(s).
SigningHashAlg
# ckStr is a CkString
mime.get_SigningHashAlg(ckStr);
strVal = mime.signingHashAlg();
mime.put_SigningHashAlg(strVal);
Selects the underlying hash algorithm used when creating signed (PKCS7) MIME. Possible values are "sha1", "sha256", "sha384", "sha512", "md5", and "md2".
Note: This property does not get set when a signature is verified. It is only used to specify the algorithm when creating a signature. The LastJsonData method can be used to get information about the verified signature(s).
topUncommonOptions
# ckStr is a CkString
mime.get_UncommonOptions(ckStr);
strVal = mime.uncommonOptions();
mime.put_UncommonOptions(strVal);
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
topUnwrapExtras
boolVal = mime.get_UnwrapExtras();
mime.put_UnwrapExtras(boolVal);
Controls whether extra (informative) header fields are added to the MIME message when unwrapping security.
UseMmDescription
boolVal = mime.get_UseMmDescription();
mime.put_UseMmDescription(boolVal);
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.
UseXPkcs7
boolVal = mime.get_UseXPkcs7();
mime.put_UseXPkcs7(boolVal);
If true, then the Content-Type header fields created by Chilkat will use "x-pkcs7" instead of simply "pkcs7" . For example:
Content-Type: multipart/signed; boundary="----=_NextPart_af8_0422_dbec3a60.7178e470"; protocol="application/x-pkcs7-signature"; micalg=sha1 or Content-Type: application/x-pkcs7-mime; name="smime.p7m"If false, then the "pcks7" is used. For example:
Content-Type: multipart/signed; boundary="----=_NextPart_af8_0422_dbec3a60.7178e470"; protocol="application/pkcs7-signature"; micalg=sha1 or Content-Type: application/pkcs7-mime; name="smime.p7m"The default value of this property is true, meaning that "x-" is used by default. top
Utf8
boolVal = mime.get_Utf8();
mime.put_Utf8(boolVal);
When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.
topVerboseLogging
boolVal = mime.get_VerboseLogging();
mime.put_VerboseLogging(boolVal);
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
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.
AddDecryptCert
Makes a certificate available for decrypting if needed by methods that decrypt, such as UnwrapSecurity. This method may be called multiple times to make more than one certificate (and it's private key) available. Alternative methods for making certificates available are UseCertVault, AddPfxSourceFile, and AddPfxSourceData.
Returns true for success, false for failure.
topAddDetachedSignature
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.
AddDetachedSignature2
# transferHeaderFields is a boolean
status = mime.AddDetachedSignature2(cert, 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.
topAddDetachedSignaturePk
# privateKey is a CkPrivateKey
status = mime.AddDetachedSignaturePk(cert, privateKey);
Adds a detached signature using a certificate and it's associated private key. This method would be used when the private key is external to the certificate -- for example, if a PFX/P12 file is not used, but instead a pair of .cer and .pem files are used (one for the certificate and one for the associated private key).
Returns true for success, false for failure.
AddDetachedSignaturePk2
# privateKey is a CkPrivateKey
# transferHeaderFields is a boolean
status = mime.AddDetachedSignaturePk2(cert, privateKey, transferHeaderFields);
Same as AddDetachedSignaturePk, except an extra argument is provided to control whether header fields from the calling MIME object are transferred to the content part of the multipart/signed object. This method transforms the calling object into a multipart/signed MIME with two sub-parts. The first contains the original content of the calling object, and the second contains the digital signature.
Returns true for success, false for failure.
topAddEncryptCert
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.
topAddHeaderField
# value is a string
status = mime.AddHeaderField(name, value);
Adds a header field to the MIME.
Returns true for success, false for failure.
AddPfxSourceData
# pfxPassword is a string
status = mime.AddPfxSourceData(pfxFileData, pfxPassword);
Adds a PFX to the object's internal list of sources to be searched for certificates and private keys when decrypting . Multiple PFX sources can be added by calling this method once for each. (On the Windows operating system, the registry-based certificate stores are also automatically searched, so it is commonly not required to explicitly add PFX sources.)
The pfxFileData contains the bytes of a PFX file (also known as PKCS12 or .p12).
Returns true for success, false for failure.
topAddPfxSourceFile
# password is a string
status = mime.AddPfxSourceFile(pfxFilePath, password);
Adds a PFX file to the object's internal list of sources to be searched for certificates and private keys when decrypting. Multiple PFX files can be added by calling this method once for each. (On the Windows operating system, the registry-based certificate stores are also automatically searched, so it is commonly not required to explicitly add PFX sources.)
The pfxFilePath contains the bytes of a PFX file (also known as PKCS12 or .p12).
Returns true for success, false for failure.
topAppendPart
status = mime.AppendPart(mime);
Appends a MIME message to the sub-parts of this message. Arbitrarily complex messages with unlimited nesting levels can be created. If the calling Mime object is not already multipart, it is automatically converted to multipart/mixed first.
Returns true for success, false for failure.
AppendPartFromFile
status = mime.AppendPartFromFile(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.
topAsnBodyToXml
When the body of a MIME part contains PKCS7 (ASN.1 in DER format, base64-encoded), this method can be used to convert the ASN.1 to an XML format for inspection. Here is an example of how an ASN.1 body might look:
Content-Type: application/x-pkcs7-mime; name="smime.p7m"; smime-type="signed-data" Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="smime.p7m" MIIXXAYJKoZIhvcNAQcCoIIXTTCCF0kCAQExCzAJBgUrDgMCGgUAMFoGCSqGSIb3DQEHAaBNBEtD b250ZW50LVR5cGU6IHRleHQvcGxhaW4NCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDdiaXQN Cg0KdGhpcyBpcyBhIHRlc3SgghI/MIIE3jCCA8agAwIBAgICAwEwDQYJKoZIhvcNAQEFBQAwYzEL ...The XML produced would look something like this:
<?xml version="1.0" encoding="utf-8" ?>
<sequence>
<oid>1.2.840.113549.1.7.2</oid>
<contextSpecific tag="0" constructed="1">
<sequence>
<int>01</int>
<set>
<sequence>
<oid>1.3.14.3.2.26</oid>
<null />
</sequence>
</set>
<sequence>
<oid>1.2.840.113549.1.7.1</oid>
<contextSpecific tag="0" constructed="1">
...
Returns true for success, false for failure.
topClearEncryptCerts
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.)
topContainsEncryptedParts
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.
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.
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
Converts existing MIME to a multipart/alternative. This is accomplished by creating a new outermost multipart/alternative MIME part. The existing MIME is moved into the 1st (and only) sub-part of the new multipart/alternative enclosure. Header fields from the original top-level MIME part are transferred to the new top-level multipart/alternative header, except for Content-Type, Content-Transfer-Encoding, and Content-Disposition. For example, the following simple plain-text MIME is converted as follows:
Original:
MIME-Version: 1.0 Date: Sun, 11 Aug 2013 11:18:44 -0500 Message-ID: <D105FA9A2B5F34E253C6E255D58247D26F8BD724@CHILKAT13> Content-Type: text/plain Content-Transfer-Encoding: quoted-printable X-Priority: 3 (Normal) Subject: this is the subject. From: "Chilkat Software" <support@chilkatsoft.com> To: "Chilkat Sales" <sales@chilkatsoft.com> This is the plain-text body.
After Converting:
MIME-Version: 1.0 Date: Sun, 11 Aug 2013 11:18:44 -0500 Message-ID: <D105FA9A2B5F34E253C6E255D58247D26F8BD724@CHILKAT13> X-Priority: 3 (Normal) Subject: this is the subject. From: "Chilkat Software" <support@chilkatsoft.com> To: "Chilkat Sales" <sales@chilkatsoft.com> Content-Type: multipart/alternative; boundary="------------040101040804050401050400_.ALT" --------------040101040804050401050400_.ALT Content-Type: text/plain Content-Transfer-Encoding: quoted-printable This is the plain-text body. --------------040101040804050401050400_.ALT--
Returns true for success, false for failure.
topConvertToMultipartMixed
Converts existing MIME to a multipart/mixed. This is accomplished by creating a new outermost multipart/mixed MIME part. The existing MIME is moved into the 1st (and only) sub-part of the new multipart/mixed enclosure. Header fields from the original top-level MIME part are transferred to the new top-level multipart/mixed header, except for Content-Type, Content-Transfer-Encoding, and Content-Disposition. For example, the following simple plain-text MIME is converted as follows:
Original:
MIME-Version: 1.0 Date: Sun, 11 Aug 2013 11:27:04 -0500 Message-ID: <B43DAF999B38BFE2C7240D86E691B8628D9D0BF4@CHILKAT13> Content-Type: text/plain Content-Transfer-Encoding: quoted-printable X-Priority: 3 (Normal) Subject: this is the subject. From: "Chilkat Software" <support@chilkatsoft.com> To: "Chilkat Sales" <sales@chilkatsoft.com> This is the plain-text body.
After Converting:
MIME-Version: 1.0 Date: Sun, 11 Aug 2013 11:27:04 -0500 Message-ID: <B43DAF999B38BFE2C7240D86E691B8628D9D0BF4@CHILKAT13> X-Priority: 3 (Normal) Subject: this is the subject. From: "Chilkat Software" <support@chilkatsoft.com> To: "Chilkat Sales" <sales@chilkatsoft.com> Content-Type: multipart/mixed; boundary="------------050508060709030908040207" --------------050508060709030908040207 Content-Type: text/plain Content-Transfer-Encoding: quoted-printable This is the plain-text body. --------------050508060709030908040207--
Returns true for success, false for failure.
ConvertToSigned
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.
ConvertToSignedPk
# privateKey is a CkPrivateKey
status = mime.ConvertToSignedPk(cert, privateKey);
Digitally signs the MIME to convert it to an "opaque" signed message using a certificate and it's associated private key. This method would be used when the private key is external to the certificate -- for example, if a PFX/P12 file is not used, but instead a pair of .cer and .pem files are used (one for the certificate and one for the associated private key).
Returns true for success, false for failure.
Decrypt
Decrypts PKCS7 encrypted MIME (also known as S/MIME). Information about the certificates required for decryption is always embedded within PKCS7 encrypted MIME. This method will automatically find and use the certificate + private key required from three possible sources:
- PFX files that were provided in one or more calls to AddPfxSourceData or AddPfxSourceFile.
- Certificates found in an XML certificate vault provided by calling the UseCertVault method.
- (On Windows systems) Certificates found in the system's registry-based certificate stores.
Returns true for success, false for failure.
Decrypt2
The same as Decrypt, but useful when the certificate and private key are available in separate files (as opposed to a single file such as a .pfx/.p12).
Returns true for success, false for failure.
DecryptUsingCert
Decrypts PKCS7 encrypted MIME (also known as S/MIME) using a specific certificate.
Returns true for success, false for failure.
topDecryptUsingPfxData
# password is a string
status = mime.DecryptUsingPfxData(pfxData, 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.
topDecryptUsingPfxFile
# pfxPassword is a string
status = mime.DecryptUsingPfxFile(pfxFilePath, 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.
Encrypt
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.
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.
ExtractPartsToFiles
# dirPath is a string
ret_stringArray = mime.ExtractPartsToFiles(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 nil on failure
FindIssuer
Finds and returns the issuer certificate. If the certificate is a root or self-issued, then the certificate returned is a copy of the caller certificate.
Returns nil on failure
topGetBodyBd
Returns the body of the MIME message in a BinData object.
Returns true for success, false for failure.
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 true for success, false for failure.
GetBodyDecoded
status = mime.GetBodyDecoded(outStr);
retStr = mime.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 true for success, false for failure.
GetBodyEncoded
status = mime.GetBodyEncoded(outStr);
retStr = mime.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 true for success, false for failure.
GetEncryptCert
Returns the Nth certificate found when decrypting. The EncryptCerts property contains the number of certificates.
Returns nil on failure
GetEntireBody
Returns the entire MIME body, including all sub-parts.
Returns true for success, false for failure.
GetEntireHead
Returns the MIME header.
Returns true for success, false for failure.
GetHeaderField
# outStr is a CkString (output)
status = mime.GetHeaderField(fieldName, outStr);
retStr = mime.getHeaderField(fieldName);
Returns the value of a MIME header field. fieldName is case-insensitive.
Returns true for success, false for failure.
GetHeaderFieldAttribute
# attrName is a string
# outStr is a CkString (output)
status = mime.GetHeaderFieldAttribute(name, attrName, outStr);
retStr = mime.getHeaderFieldAttribute(name, attrName);
Parses a MIME header field and returns the value of an attribute. MIME header fields w/ attributes are formatted like this:
Header-Name: value; attrName1="value1"; attrName2="value2"; .... attrNameN="valueN"Semi-colons separate attribute name=value pairs. The Content-Type header field often contains attributes. Here is an example:
Content-Type: multipart/signed; protocol="application/x-pkcs7-signature"; micalg=SHA1; boundary="----=_NextPart_000_0000_01CB03E4.D0BAF010"In the above example, to access the value of the "protocol" attribute, call GetHeaderFieldAttribute("Content-Type", "protocol");
Returns true for success, false for failure.
GetHeaderFieldName
# outStr is a CkString (output)
status = mime.GetHeaderFieldName(index, outStr);
retStr = mime.getHeaderFieldName(index);
GetHeaderFieldValue
# outStr is a CkString (output)
status = mime.GetHeaderFieldValue(index, outStr);
retStr = mime.getHeaderFieldValue(index);
GetMime
Returns a string containing the complete MIME message, including all sub-parts.
Returns true for success, false for failure.
topGetMimeBd
Appends the MIME to a BinData object.
Returns true for success, false for failure.
GetMimeBytes
Returns a byte array containing the complete MIME message, including all sub-parts.
Returns true for success, false for failure.
GetMimeSb
Appends the MIME to a StringBuilder object.
Returns true for success, false for failure.
GetPart
# index is an integer
ret_mime = mime.GetPart(index);
GetSignatureSigningTimeStr
# outStr is a CkString (output)
status = mime.GetSignatureSigningTimeStr(index, outStr);
retStr = mime.getSignatureSigningTimeStr(index);
The same as the GetSignatureSigningTime method, but returns tjhe date/time in RFC822 string format.
Returns true for success, false for failure.
topGetSignerCert
Returns the Nth digital certificate used to sign the MIME message. Indexing begins at 0.
Returns nil on failure
GetSignerCertChain
Returns the full certificate chain for the Nth certificate used to sign the MIME message. Indexing begins at 0.
Returns nil on failure
topGetStructure
# outStr is a CkString (output)
status = mime.GetStructure(fmt, outStr);
retStr = mime.getStructure(fmt);
Returns a string summarizing the MIME structure. The output format is specified by fmt and can be "text" or "xml".
Returns true for success, false for failure.
GetXml
Converts the MIME (or S/MIME) message to XML and returns the XML as a string.
Returns true for success, false for failure.
HasSignatureSigningTime
retBool = mime.HasSignatureSigningTime(index);
Returns true if the Nth signature included a timestamp that recorded the signing time. The number of signatures (i.e. signer certs) is indicated by the NumSignerCerts property. (In most cases, the number of signer certs is 1.) The signing time can be obtained via the GetSignatureSigningTime or GetSignatureSigningTimeStr methods. The index of the 1st signature signing time is 0.
topIsApplicationData
Return true if the MIME message contains application data, otherwise returns false.
topIsAttachment
Return true if this MIME message is an attachment, otherwise returns false. A MIME message is considered an attachment if the Content-Disposition header field contains the value "attachment".
topIsAudio
Return true if the MIME message contains audio data, otherwise returns false.
topIsEncrypted
Returns true if the MIME message is PKCS7 encrypted, otherwise returns false.
topIsHtml
Return true if the MIME body is HTML, otherwise returns false.
topIsImage
Return true if the MIME message contains image data, otherwise returns false.
topIsMultipart
Return true if the MIME message is multipart (multipart/mixed, multipart/related, multipart/alternative, etc.), otherwise returns false.
topIsMultipartAlternative
Return true if the MIME message is multipart/alternative, otherwise returns false.
topIsMultipartMixed
Return true if the MIME message is multipart/mixed, otherwise returns false.
topIsMultipartRelated
Return true if the MIME message is multipart/related, otherwise returns false.
topIsPlainText
Return true if the MIME message body is plain text, otherwise returns false.
topIsSigned
Return true if the MIME message is PKCS7 digitally signed, otherwise returns false.
topIsText
Return true if the MIME message body is any text content type, such as text/plain, text/html, text/xml, etc., otherwise returns false.
topIsVideo
Return true if the MIME message contains video data, otherwise returns false.
topIsXml
Return true if the MIME message body is XML, otherwise returns false.
topLastJsonData
Provides information about what transpired in the last method called on this object instance. For many methods, there is no information. However, for some methods, details about what occurred can be obtained by getting the LastJsonData right after the method call returns. For example, after calling UnwrapSecurity, the LastJsonData will return JSON with details about the algorithms used for signature verification and decryption.
Returns nil on failure
LoadMime
status = mime.LoadMime(mimeMsg);
Discards the current contents of the MIME object and loads a new MIME message from a string.
Returns true for success, false for failure.
topLoadMimeBd
Discards the current contents of the MIME object and loads a new MIME message from a BinData object.
Returns true for success, false for failure.
topLoadMimeBytes
LoadMimeFile
status = mime.LoadMimeFile(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.
topLoadMimeSb
Discards the current contents of the MIME object and loads a new MIME message from a StringBuilder.
Returns true for success, false for failure.
LoadXml
status = mime.LoadXml(xml);
Converts XML to MIME and replaces the MIME object's contents with the converted XML.
Returns true for success, false for failure.
topLoadXmlFile
status = mime.LoadXmlFile(fileName);
Converts XML to MIME and replaces the MIME object's contents with the converted XML.
Returns true for success, false for failure.
topNewMessageRfc822
status = mime.NewMessageRfc822(mimeObject);
Clears the Mime object and initializes it such that the header contains a "content-type: message/rfc822" line and the body is the MIME text of the Mime object passed to the method.
Returns true for success, false for failure.
topNewMultipartAlternative
Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/alternative message.
Returns true for success, false for failure.
NewMultipartMixed
Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/mixed message.
Returns true for success, false for failure.
NewMultipartRelated
Discards the current MIME message header fields and contents, if any, an initializes the MIME object to be an empty mulipart/related message.
Returns true for success, false for failure.
RemoveHeaderField
# bAllOccurrences is a boolean
mime.RemoveHeaderField(fieldName, bAllOccurrences);
Removes a header field from the MIME header. If bAllOccurrences is true, then all occurrences of the header field are removed. Otherwise, only the 1st occurrence is removed.
RemovePart
status = mime.RemovePart(index);
SaveBody
status = mime.SaveBody(filename);
Saves the MIME message body to a file. If the body is base64 or quoted-printable encoded, it is automatically decoded.
Returns true for success, false for failure.
SaveMime
status = mime.SaveMime(filename);
Saves the MIME message to a file, in MIME format. (This is the same as the .EML format used by Microsoft Outlook Express.)
Returns true for success, false for failure.
topSaveXml
status = mime.SaveXml(filename);
Converts the MIME message to XML and saves to an XML file.
Returns true for success, false for failure.
topSetBody
mime.SetBody(str);
SetBodyFromBinary
Sets the MIME message body from a byte array.
Returns true for success, false for failure.
SetBodyFromEncoded
# str is a string
status = mime.SetBodyFromEncoded(encoding, str);
Sets the MIME message body from a Base64 or Quoted-Printable encoded string.
Returns true for success, false for failure.
SetBodyFromFile
status = mime.SetBodyFromFile(fileName);
Sets the MIME message body from the contents of a file. Note: A MIME message consists of a header and a body. The body may itself be a MIME message that consists of a header and body, etc. This method loads the contents of a file into the body of a MIME message, without replacing the header.
The Content-Type and Content-Transfer-Encoding header fields are automatically updated to match the type of content loaded (based on file extension). If your application requires the MIME to have a specific Content-Type and/or Content-Transfer-Encoding, set the ContentType and Encoding properties after calling this method (not before).
Returns true for success, false for failure.
SetBodyFromHtml
status = mime.SetBodyFromHtml(str);
Sets the MIME message body from a string containing HTML. The Content-Type header is added or updated to the value "text/html".
If 8bit (non-us-ascii) characters are present, and if the Charset property was not previously set, then the "charset" attribute is automatically added to the Content-Type header using the default value of "utf-8". This can be changed at any time by setting the Charset property.
If the Encoding property was not previously set, then the Content-Transfer-Encoding header is automatically added. It will be set to "7bit" or "8bit" depending on whether the HTML body contains 8-bit non-us-ascii characters.
To set the MIME body with no intentional side-effects, use SetBody instead.
Returns true for success, false for failure.
SetBodyFromPlainText
status = mime.SetBodyFromPlainText(str);
Sets the MIME message body from a string containing plain-text. The Content-Type header is added or updated to the value "text/plain".
If 8bit (non-us-ascii) characters are present, and if the Charset property was not previously set, then the "charset" attribute is automatically added to the Content-Type header using the default value of "utf-8". This can be changed at any time by setting the Charset property.
If the Encoding property was not previously set, then the Content-Transfer-Encoding header is automatically added. It will be set to "7bit" or "8bit" depending on whether the plain-text body contains 8-bit non-us-ascii characters.
To set the MIME body with no intentional side-effects, use SetBody instead.
Returns true for success, false for failure.
SetBodyFromXml
status = mime.SetBodyFromXml(str);
Sets the MIME message body from a string containing XML. The Content-Type header is added or updated to the value "text/xml".
If 8bit (non-us-ascii) characters are present, and if the Charset property was not previously set, then the "charset" attribute is automatically added to the Content-Type header using the default value of "utf-8". This can be changed at any time by setting the Charset property.
If the Encoding property was not previously set, then the Content-Transfer-Encoding header is automatically added. It will be set to "7bit" or "8bit" depending on whether the plain-text body contains 8-bit non-us-ascii characters.
To set the MIME body with no intentional side-effects, use SetBody instead.
Returns true for success, false for failure.
SetHeaderField
# value is a string
status = mime.SetHeaderField(name, value);
Adds or replaces a MIME message header field. If the field already exists, it is automatically replaced. Otherwise it is added. Pass zero-length value to remove the header field.
Returns true for success, false for failure.
SetVerifyCert
Allows a certificate to be explicitly specified for verifying a signature.
Returns true for success, false for failure.
topUnwrapSecurity
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.
UrlEncodeBody
mime.UrlEncodeBody(charset);
URL encodes the MIME body. The charset is important. For example, consider this MIME:
Content-Type: text/plain Content-Transfer-Encoding: 8bit SociétéIf the charset is set to "utf-8", then the following is produced:
Content-Type: text/plain Content-Transfer-Encoding: 8bit Soci%C3%A9t%C3%A9However, if the charset is set to "ansi", then the following is the result:
Content-Type: text/plain Content-Transfer-Encoding: 8bit Soci%E9t%E9top
UseCertVault
Adds an XML certificate vault to the object's internal list of sources to be searched for certificates and private keys when encrypting/decrypting or signing/verifying. Unlike the AddPfxSourceData and AddPfxSourceFile methods, only a single XML certificate vault can be used. If UseCertVault is called multiple times, only the last certificate vault will be used, as each call to UseCertVault will replace the certificate vault provided in previous calls.
Returns true for success, false for failure.
topVerify
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.