Dkim PureBasic Reference Documentation

Dkim

Current Version: 10.1.2

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.i = CkDkim::ckCreate()

; Make sure to dispose of the object when finished like this:
CkDkim::ckDispose(obj);

Properties

AbortCurrent
Declare.i ckAbortCurrent(obj.i)
Declare setCkAbortCurrent(obj.i, value.i)
Introduced in version 9.5.0.58

When set to 1, 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 0 when the next method is called. When the abort occurs, this property is reset to 0. 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
Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
top
DkimAlg
Declare.s ckDkimAlg(obj.i)
Declare setCkDkimAlg(obj.i, value.s)

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
Declare.i ckDkimBodyLengthCount(obj.i)
Declare setCkDkimBodyLengthCount(obj.i, value.i)

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
Declare.s ckDkimCanon(obj.i)
Declare setCkDkimCanon(obj.i, value.s)

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
Declare.s ckDkimDomain(obj.i)
Declare setCkDkimDomain(obj.i, value.s)

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

top
DkimHeaders
Declare.s ckDkimHeaders(obj.i)
Declare setCkDkimHeaders(obj.i, value.s)

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
Declare.s ckDkimSelector(obj.i)
Declare setCkDkimSelector(obj.i, value.s)

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
Declare.s ckDomainKeyAlg(obj.i)
Declare setCkDomainKeyAlg(obj.i, value.s)

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
Declare.s ckDomainKeyCanon(obj.i)
Declare setCkDomainKeyCanon(obj.i, value.s)

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

top
DomainKeyDomain
Declare.s ckDomainKeyDomain(obj.i)
Declare setCkDomainKeyDomain(obj.i, value.s)

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

top
DomainKeyHeaders
Declare.s ckDomainKeyHeaders(obj.i)
Declare setCkDomainKeyHeaders(obj.i, value.s)

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
Declare.s ckDomainKeySelector(obj.i)
Declare setCkDomainKeySelector(obj.i, value.s)

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
Declare.s ckLastErrorHtml(obj.i) ; (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
Declare.s ckLastErrorText(obj.i) ; (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
Declare.s ckLastErrorXml(obj.i) ; (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
VerboseLogging
Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
VerifyInfo
Declare.s ckVerifyInfo(obj.i) ; (read-only)
Introduced in version 9.5.0.76

Contains JSON with information about the last DKIM or DomainKey signature verified (or verification failure). The JSON will contain information like this:

{
  "domain": "amazonses.com",
  "selector": "7v7vs6w47njt4pimodk5mmttbegzsi6n",
  "publicKey": "MIGfMA0GCSq...z6uqeQIDAQAB",
  "canonicalization": "relaxed/simple",
  "algorithm": "rsa-sha256",
  "signedHeaders": "Subject:From:To:Date:Mime-Version:Content-Type:References:Message-Id:Feedback-ID",
  "verified": "yes"
}

top
Version
Declare.s ckVersion(obj.i) ; (read-only)

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

More Information and Examples
top

Methods

DkimSign
Declare.i ckDkimSign(obj.i, mimeData.i)
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 1 for success, 0 for failure.

More Information and Examples
top
DkimVerify
Declare.i ckDkimVerify(obj.i, sigIndex.l, mimeData.i)
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.

On return, the VerifyInfo property will contain additional information about the DKIM-Signature that was verified (or not verified).

Returns 1 for success, 0 for failure.

top
DomainKeySign
Declare.i ckDomainKeySign(obj.i, mimeData.i)
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 1 for success, 0 for failure.

top
DomainKeyVerify
Declare.i ckDomainKeyVerify(obj.i, sigIndex.l, mimeData.i)
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.

On return, the VerifyInfo property will contain additional information about the DKIM-Signature that was verified (or not verified).

Returns 1 for success, 0 for failure.

top
LoadPublicKey
Declare.i ckLoadPublicKey(obj.i, selector.s, domain.s, publicKey.s)

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 1 for success, 0 for failure.

top
LoadPublicKeyFile
Declare.i ckLoadPublicKeyFile(obj.i, selector.s, domain.s, publicKeyFilepath.s)

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 1 for success, 0 for failure.

top
LoadTaskCaller
Declare.i ckLoadTaskCaller(obj.i, task.i)
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

top
NumDkimSigs
Declare.i ckNumDkimSigs(obj.i, mimeData.i)
Introduced in version 9.5.0.76

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

top
NumDomainKeySigs
Declare.i ckNumDomainKeySigs(obj.i, mimeData.i)
Introduced in version 9.5.0.76

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

top
PrefetchPublicKey
Declare.i ckPrefetchPublicKey(obj.i, selector.s, domain.s)

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 1 for success, 0 for failure.

top
PrefetchPublicKeyAsync (1)
Declare.i ckPrefetchPublicKeyAsync(obj.i, selector.s, domain.s)

Creates an asynchronous task to call the PrefetchPublicKey method with the arguments provided.

Returns 0 on failure

top
SetDkimPrivateKey
Declare.i ckSetDkimPrivateKey(obj.i, privateKey.i)
Introduced in version 9.5.0.71

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

Returns 1 for success, 0 for failure.

top
SetDomainKeyPrivateKey
Declare.i ckSetDomainKeyPrivateKey(obj.i, privateKey.i)
Introduced in version 9.5.0.71

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

Returns 1 for success, 0 for failure.

top