Dkim Perl Reference Documentation
CkDkim
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 = chilkat::CkDkim->new();
Properties
AbortCurrent
$boolVal = $dkim->get_AbortCurrent();
$dkim->put_AbortCurrent($boolVal);
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.)
topDebugLogFilePath
# $ckStr is a CkString
$dkim->get_DebugLogFilePath($ckStr);
$strVal = $dkim->debugLogFilePath();
$dkim->put_DebugLogFilePath($strVal);
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.
DkimAlg
# $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".
topDkimBodyLengthCount
$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.
topDkimCanon
# $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".
topDkimDomain
# $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.
topDkimHeaders
# $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".
topDkimSelector
# $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".
topDomainKeyAlg
# $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".
topDomainKeyCanon
# $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".
topDomainKeyDomain
# $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.
topDomainKeyHeaders
# $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".
topDomainKeySelector
# $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".
topLastErrorHtml
# $ckStr is a CkString
$dkim->get_LastErrorHtml($ckStr);
$strVal = $dkim->lastErrorHtml();
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.
topLastErrorText
# $ckStr is a CkString
$dkim->get_LastErrorText($ckStr);
$strVal = $dkim->lastErrorText();
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.
LastErrorXml
# $ckStr is a CkString
$dkim->get_LastErrorXml($ckStr);
$strVal = $dkim->lastErrorXml();
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.
topLastMethodSuccess
$boolVal = $dkim->get_LastMethodSuccess();
$dkim->put_LastMethodSuccess($boolVal);
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.
topUtf8
$boolVal = $dkim->get_Utf8();
$dkim->put_Utf8($boolVal);
When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.
topVerboseLogging
$boolVal = $dkim->get_VerboseLogging();
$dkim->put_VerboseLogging($boolVal);
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.
topVerifyInfo
# $ckStr is a CkString
$dkim->get_VerifyInfo($ckStr);
$strVal = $dkim->verifyInfo();
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"
}
Version
# $ckStr is a CkString
$dkim->get_Version($ckStr);
$strVal = $dkim->version();
Methods
DkimSign
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.
DkimVerify
# $mimeData is a CkBinData
$status = $dkim->DkimVerify($sigIndex, $mimeData);
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.
DomainKeySign
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.
topDomainKeyVerify
# $mimeData is a CkBinData
$status = $dkim->DomainKeyVerify($sigIndex, $mimeData);
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.
LoadPublicKey
# $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 1 for success, 0 for failure.
topLoadPublicKeyFile
# $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 1 for success, 0 for failure.
topLoadTaskCaller
NumDkimSigs
Returns the number of DKIM-Signature header fields found in mimeData.
NumDomainKeySigs
Returns the number of DomainKey-Signature header fields found in mimeData.
PrefetchPublicKey
# $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 1 for success, 0 for failure.
topPrefetchPublicKeyAsync (1)
# $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.
Returns null on failure
topSetDkimPrivateKey
Sets the private key file to be used for creating a DKIM-Signature.
Returns 1 for success, 0 for failure.
topSetDomainKeyPrivateKey
Sets the private key file to be used for creating a DomainKey-Signature.
Returns 1 for success, 0 for failure.
top