CkDkim Ruby Reference Documentation

CkDkim

Current Version: 9.5.0.73

DomainKeys API for creating and verifying DKIM-Signature and DomainKey-Signature MIME (email) header fields. This API is included with the "Chilkat MIME" license. ("Chilkat MIME" may be referred to as "Chilkat S/MIME" on some chilkatsoft.com web pages. They are the same product.)

Object Creation

obj = Chilkat::CkDkim.new()

Properties

AbortCurrent
# boolVal is a boolean
boolVal = dkim.get_AbortCurrent();
dkim.put_AbortCurrent(boolVal);
Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

top
DebugLogFilePath
# strVal is a string
# ckStr is a CkString
dkim.get_DebugLogFilePath(ckStr);
strVal = dkim.debugLogFilePath();
dkim.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:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DkimAlg
# strVal is a string
# ckStr is a CkString
dkim.get_DkimAlg(ckStr);
strVal = dkim.dkimAlg();
dkim.put_DkimAlg(strVal);

The signing algorithm to be used in creating the DKIM-Signature. Possible values are "rsa-sha256" and "rsa-sha1". The default value is "rsa-sha256".

top
DkimBodyLengthCount
# intVal is an integer
intVal = dkim.get_DkimBodyLengthCount();
dkim.put_DkimBodyLengthCount(intVal);

Optional body length count to set a maximum number of body bytes to be hashed when creating the DKIM-Signature field. The default value is 0, indicating that the entire body should be hashed.

top
DkimCanon
# strVal is a string
# ckStr is a CkString
dkim.get_DkimCanon(ckStr);
strVal = dkim.dkimCanon();
dkim.put_DkimCanon(strVal);

Canonicalization algorithm to be used for both header and body when creating the DKIM-Signature. Possible values are "simple" and "relaxed". The default value is "relaxed".

top
DkimDomain
# strVal is a string
# ckStr is a CkString
dkim.get_DkimDomain(ckStr);
strVal = dkim.dkimDomain();
dkim.put_DkimDomain(strVal);

The domain name of the signing domain when creating the DKIM-Signature.

top
DkimHeaders
# strVal is a string
# ckStr is a CkString
dkim.get_DkimHeaders(ckStr);
strVal = dkim.dkimHeaders();
dkim.put_DkimHeaders(strVal);

A colon-separated list of header field names that identify headers presented to the signing algorithm when creating the DKIM-Signature. The default value is: "mime-version:date:message-id:subject:from:to:content-type".

top
DkimSelector
# strVal is a string
# ckStr is a CkString
dkim.get_DkimSelector(ckStr);
strVal = dkim.dkimSelector();
dkim.put_DkimSelector(strVal);

The selector to be used to form the DNS query for the public key. This property applies to creating a DKIM-Signature. For example, if the selector is "reykjavik" and the domain is "example-code.com", then the DNS query would be for "reykjavik._domainkey.example-code.com".

top
DomainKeyAlg
# strVal is a string
# ckStr is a CkString
dkim.get_DomainKeyAlg(ckStr);
strVal = dkim.domainKeyAlg();
dkim.put_DomainKeyAlg(strVal);

The signing algorithm to be used in creating the DomainKey-Signature. The only possible value is "rsa-sha1". The default value is "rsa-sha1".

top
DomainKeyCanon
# strVal is a string
# ckStr is a CkString
dkim.get_DomainKeyCanon(ckStr);
strVal = dkim.domainKeyCanon();
dkim.put_DomainKeyCanon(strVal);

Canonicalization algorithm to be used for when creating the DomainKey-Signature. Possible values are "simple" and "nofws". The default value is "nofws".

top
DomainKeyDomain
# strVal is a string
# ckStr is a CkString
dkim.get_DomainKeyDomain(ckStr);
strVal = dkim.domainKeyDomain();
dkim.put_DomainKeyDomain(strVal);

The domain name of the signing domain when creating the DomainKey-Signature.

top
DomainKeyHeaders
# strVal is a string
# ckStr is a CkString
dkim.get_DomainKeyHeaders(ckStr);
strVal = dkim.domainKeyHeaders();
dkim.put_DomainKeyHeaders(strVal);

A colon-separated list of header field names that identify headers presented to the signing algorithm when creating the DomainKey-Signature. The default value is: "mime-version:date:message-id:subject:from:to:content-type".

top
DomainKeySelector
# strVal is a string
# ckStr is a CkString
dkim.get_DomainKeySelector(ckStr);
strVal = dkim.domainKeySelector();
dkim.put_DomainKeySelector(strVal);

The selector to be used to form the DNS query for the public key. This property applies to creating a DomainKey-Signature. For example, if the selector is "reykjavik" and the domain is "example-code.com", then the DNS query would be for "reykjavik._domainkey.example-code.com".

top
LastErrorHtml
# strVal is a string
# ckStr is a CkString
dkim.get_LastErrorHtml(ckStr);
strVal = dkim.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.

top
LastErrorText
# strVal is a string
# ckStr is a CkString
dkim.get_LastErrorText(ckStr);
strVal = dkim.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.

top
LastErrorXml
# strVal is a string
# ckStr is a CkString
dkim.get_LastErrorXml(ckStr);
strVal = dkim.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.

top
LastMethodSuccess
# boolVal is a boolean
boolVal = dkim.get_LastMethodSuccess();
dkim.put_LastMethodSuccess(boolVal);
Introduced in version 9.5.0.52

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.

top
Utf8
# boolVal is a boolean
boolVal = dkim.get_Utf8();
dkim.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.

top
VerboseLogging
# boolVal is a boolean
boolVal = dkim.get_VerboseLogging();
dkim.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.

top
Version
# strVal is a string
# ckStr is a CkString
dkim.get_Version(ckStr);
strVal = dkim.version();

Version of the component/library, such as "9.5.0.63"

top

Methods

AddDkimSignature
# mimeIn is a CkByteData
# outBytes is a CkByteData (output)
status = dkim.AddDkimSignature(mimeIn, outData);
This method is deprecated. It will be removed in a future version.

Constructs and prepends a DKIM-Signature header to the MIME. Prior to calling this method, your program must set both the DkimDomain and DkimSelector properties, and it must load a private key by calling LoadDkimPk or LoadDkimPkFile.

Note: This method is deprecated. Use the DkimSign method instead.

Returns true for success, false for failure.

top
AddDomainKeySignature
# mimeIn is a CkByteData
# outBytes is a CkByteData (output)
status = dkim.AddDomainKeySignature(mimeIn, outData);
This method is deprecated. It will be removed in a future version.

Constructs and prepends a DomainKey-Signature header to the MIME. Prior to calling this method, your program must set both the DomainKeyDomain and DomainKeySelector properties, and it must load a private key by calling LoadDomainKeyPk or LoadDomainKeyPkFile.

Note: This method is deprecated. Use the DomainKeySign method instead.

Returns true for success, false for failure.

More Information and Examples
top
DkimSign
# mimeData is a CkBinData
status = dkim.DkimSign(mimeData);
Introduced in version 9.5.0.71

Constructs and prepends a DKIM-Signature header to the MIME passed in mimeData. Prior to calling this method, your program must set both the DkimDomain and DkimSelector properties, and it must load a private key by calling SetDkimPrivateKey.

Returns true for success, false for failure.

top
DkimVerify
# sigIndex is an integer
# mimeData is a CkBinData
status = dkim.DkimVerify(sigIndex, mimeData);
Introduced in version 9.5.0.71

Verifies the Nth DKIM-Signature header in the mimeData. (In most cases, there is only one signature.) The 1st signature is at sigIndex 0.

Important: Many anti-virus programs, such as AVG, will modify the MIME of an email as it is received. This will cause DKIM signature verification to fail because the body of the MIME is modified.

Returns true for success, false for failure.

top
DomainKeySign
# mimeData is a CkBinData
status = dkim.DomainKeySign(mimeData);
Introduced in version 9.5.0.71

Constructs and prepends a DomainKey-Signature header to the MIME passed in mimeData. Prior to calling this method, your program must set both the DomainKeyDomain and DomainKeySelector properties, and it must load a private key by calling SetDomainKeyPrivateKey.

Returns true for success, false for failure.

top
DomainKeyVerify
# sigIndex is an integer
# mimeData is a CkBinData
status = dkim.DomainKeyVerify(sigIndex, mimeData);
Introduced in version 9.5.0.71

Verifies the Nth DomainKey-Signature header in the mimeData. (In most cases, there is only one signature.) The 1st signature is at sigIndex 0.

Important: Many anti-virus programs, such as AVG, will modify the MIME of an email as it is received. This will cause DomainKey signature verification to fail because the body of the MIME is modified.

Returns true for success, false for failure.

top
LoadDkimPk
# privateKey is a string
# optionalPassword is a string
status = dkim.LoadDkimPk(privateKey, optionalPassword);
This method is deprecated. It will be removed in a future version.

Loads an RSA private key to be used for creating a DKIM-Signature. Any valid RSA private key format that is not binary, such as PEM or XML, may be passed to this method. This method will automatically determine the format and parse it correctly. A password is only required if key is encrypted, such as for encrypted PEM.

Note: This method is deprecated. Use the SetDkimPrivateKey method instead.

Returns true for success, false for failure.

top
LoadDkimPkBytes
# privateKeyDer is a CkByteData
# optionalPassword is a string
status = dkim.LoadDkimPkBytes(privateKeyDer, optionalPassword);
This method is deprecated. It will be removed in a future version.

Loads an RSA private key to be used for creating a DKIM-Signature. Any valid RSA private key binary format, such as DER, may be passed to this method. This method will automatically determine the format and parse it correctly. A password is only required if key is encrypted.

Note: This method is deprecated. Use the SetDkimPrivateKey method instead.

Returns true for success, false for failure.

top
LoadDkimPkFile
# privateKeyFilePath is a string
# optionalPassword is a string
status = dkim.LoadDkimPkFile(privateKeyFilePath, optionalPassword);
This method is deprecated. It will be removed in a future version.

Loads an RSA private key file to be used for creating a DKIM-Signature. The file name contains any valid RSA private key format, such as DER, PKCS8, PEM, XML, etc. This method will automatically determine the format and parse it correctly. A password is only required if key is encrypted, such as for encrypted PEM or encrypted PKCS8.

Note: This method is deprecated. Use the SetDkimPrivateKey method instead.

Returns true for success, false for failure.

top
LoadDomainKeyPk
# privateKey is a string
# optionalPassword is a string
status = dkim.LoadDomainKeyPk(privateKey, optionalPassword);
This method is deprecated. It will be removed in a future version.

Loads an RSA private key to be used for creating a DomainKey-Signature. Any valid RSA private key format that is not binary, such as PEM or XML, may be passed to this method. This method will automatically determine the format and parse it correctly. A password is only required if key is encrypted, such as for encrypted PEM.

Note: This method is deprecated. Use the SetDomainKeyPrivateKey method instead.

Returns true for success, false for failure.

top
LoadDomainKeyPkBytes
# privateKeyDer is a CkByteData
# optionalPassword is a string
status = dkim.LoadDomainKeyPkBytes(privateKeyDer, optionalPassword);
This method is deprecated. It will be removed in a future version.

Loads an RSA private key to be used for creating a DomainKey-Signature. Any valid RSA private key binary format, such as DER, may be passed to this method. This method will automatically determine the format and parse it correctly. A password is only required if key is encrypted.

Note: This method is deprecated. Use the SetDomainKeyPrivateKey method instead.

Returns true for success, false for failure.

top
LoadDomainKeyPkFile
# privateKeyFilePath is a string
# optionalPassword is a string
status = dkim.LoadDomainKeyPkFile(privateKeyFilePath, optionalPassword);
This method is deprecated. It will be removed in a future version.

Loads an RSA private key file to be used for creating a DomainKey-Signature. The file name contains any valid RSA private key format, such as DER, PKCS8, PEM, XML, etc. This method will automatically determine the format and parse it correctly. A password is only required if key is encrypted, such as for encrypted PEM or encrypted PKCS8.

Note: This method is deprecated. Use the SetDomainKeyPrivateKey method instead.

Returns true for success, false for failure.

top
LoadPublicKey
# selector is a string
# domain is a string
# publicKey is a string
status = dkim.LoadPublicKey(selector, domain, publicKey);

Caches a public key to be used for verifying DKIM and DomainKey signatures for a given selector and domain. The publicKey is a string containing an RSA public key in any text format, such as XML, PEM, etc. This method will automatically detect the format and load the public key correctly. This method is useful for testing DKIM and DomainKey verification when your public key has not yet been installed in DNS.

Returns true for success, false for failure.

top
LoadPublicKeyFile
# selector is a string
# domain is a string
# publicKeyFilepath is a string
status = dkim.LoadPublicKeyFile(selector, domain, publicKeyFilepath);

Caches a public key to be used for verifying DKIM and DomainKey signatures for a given selector and domain. The publicKeyFilepath is a filepath of an RSA public key in any format. This method will automatically detect the format and load the public key correctly. This method is useful for testing DKIM and DomainKey verification when your public key has not yet been installed in DNS.

Returns true for success, false for failure.

top
NumDkimSignatures
# mimeData is a CkByteData
retInt = dkim.NumDkimSignatures(mimeData);

Returns the number of DKIM-Signature header fields found in mimeData.

top
NumDomainKeySignatures
# mimeData is a CkByteData
retInt = dkim.NumDomainKeySignatures(mimeData);

Returns the number of DomainKey-Signature header fields found in mimeData.

top
PrefetchPublicKey
# selector is a string
# domain is a string
status = dkim.PrefetchPublicKey(selector, domain);

Useful if your application is going to verify many emails from a single domain (or a few domains). This eliminates the need to do a DNS lookup to fetch the public key each time an email's DKIM or DomainKey signature is verified.

This method may be called multiple times -- once for each selector/domain to be pre-fetched. The verify methods (VerifyDkimSignature and VerifyDomainKeySignature) will use a pre-fetched key if the selector and domain match.

Returns true for success, false for failure.

top
PrefetchPublicKeyAsync (1)
# returns a CkTask
# selector is a string
# domain is a string
ret_task = dkim.PrefetchPublicKeyAsync(selector, domain);

Creates an asynchronous task to call the PrefetchPublicKey method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns nil on failure

top
SaveLastError
# path is a string
status = dkim.SaveLastError(path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top
SetDkimPrivateKey
# privateKey is a CkPrivateKey
status = dkim.SetDkimPrivateKey(privateKey);
Introduced in version 9.5.0.71

Sets the private key file to be used for creating a DKIM-Signature.

Returns true for success, false for failure.

top
SetDomainKeyPrivateKey
# privateKey is a CkPrivateKey
status = dkim.SetDomainKeyPrivateKey(privateKey);
Introduced in version 9.5.0.71

Sets the private key file to be used for creating a DomainKey-Signature.

Returns true for success, false for failure.

top
UnlockComponent
# unlockCode is a string
status = dkim.UnlockComponent(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.

top
VerifyDkimSignature
# sigIndex is an integer
# mimeData is a CkByteData
status = dkim.VerifyDkimSignature(sigIndex, mimeData);
This method is deprecated. It will be removed in a future version.

Verifies the Nth DKIM-Signature header in the mimeData. (In most cases, there is only one signature.) The 1st signature is at sigIndex 0.

Important: Many anti-virus programs, such as AVG, will modify the MIME of an email as it is received. This will cause DKIM signature verification to fail because the body of the MIME is modified.

Note: This method is deprecated. Use the DkimVerify method instead.

Returns true for success, false for failure.

top
VerifyDkimSignatureAsync (1)
# returns a CkTask
# sigIndex is an integer
# mimeData is a CkByteData
ret_task = dkim.VerifyDkimSignatureAsync(sigIndex, mimeData);
This method is deprecated. It will be removed in a future version.

Creates an asynchronous task to call the VerifyDkimSignature method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns nil on failure

top
VerifyDomainKeySignature
# sigIndex is an integer
# mimeData is a CkByteData
status = dkim.VerifyDomainKeySignature(sigIndex, mimeData);
This method is deprecated. It will be removed in a future version.

Verifies the Nth DomainKey-Signature header in the mimeData. (In most cases, there is only one signature.) The 1st signature is at sigIndex 0.

Important: Many anti-virus programs, such as AVG, will modify the MIME of an email as it is received. This will cause DomainKey signature verification to fail because the body of the MIME is modified.

Note: This method is deprecated. Use the DomainKeyVerify method instead.

Returns true for success, false for failure.

top
VerifyDomainKeySignatureAsync (1)
# returns a CkTask
# sigIndex is an integer
# mimeData is a CkByteData
ret_task = dkim.VerifyDomainKeySignatureAsync(sigIndex, mimeData);
This method is deprecated. It will be removed in a future version.

Creates an asynchronous task to call the VerifyDomainKeySignature method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns nil on failure

top