Creates a new instance extracting the userIp, userAgent, referrer and serverEnv environment variables from a Servlet request.
See the Akismet API for more details.
Creates a new instance.
See the Akismet API for more details.
IP address of the comment submitter.
User agent string of the web browser submitting the comment.
Administrator role. If used, Akismet will always return false.
A blog post.
A blog comment.
A contact form or feedback form submission.
A top-level forum post.
A message sent between just a few users.
A pingback.
A reply to a top-level forum post.
A new user account.
A trackback.
A Twitter message.
Email address submitted with the comment.
The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1
The UTC timestamp of the creation of the comment, in ISO 8601 format.
May be omitted if the comment is sent to the API at the time it is created.
A comment to send to Akismet.
Most everything is optional. Performance can drop dramatically if you choose to exclude data points. The more data you send Akismet about each comment, the greater the accuracy. They recommend erring on the side of including too much data.
See the Akismet API for more details.
IP address of the comment submitter.
User agent string of the web browser submitting the comment.
Email address submitted with the comment.
The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1
The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.
If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.
A string that describes the type of content being sent, such as:
The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.
If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.
For example: edit
In PHP, there is an array of environmental variables called $_SERVER that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.
How the submitted content interacts with the server can be very telling, so please include as much of it as possible.
Returns a JSON representation of the comment.
Returns a JSON representation of the comment.
A string that describes the type of content being sent, such as:
You may send a value not listed above if none of them accurately describe your content.
This is further explained here.
The user role of the user who submitted the comment. This is an optional parameter.
If you set it to ADMIN_ROLE, Akismet will always return false.
Converts a date to a UTC timestamp. (ISO 8601)
Converts a locale date/time to a UTC timestamp. (ISO 8601)
(Re)Creates a comment from a JSON string.
(Re)Creates a comment from a JSON string.
The application user agent to be sent to Akismet.
If possible, the application user agent string should always use the following format:
Application Name/VersionThe library's own user agent string will automatically be appended.
See the Akismet API for more details.
Comment Check.
This is the call you will make the most. It takes a number of arguments and characteristics about the submitted content and then returns a thumbs up or thumbs down. Performance can drop dramatically if you choose to exclude data points. The more data you send Akismet about each comment, the greater the accuracy. They recommend erring on the side of including too much data
By default, if an error (IO, empty response from Akismet, etc.) occurs the function will return false and log the error, use the trueOnError parameter to change this behavior.
See the Akismet API for more details.
true if the comment is spam, false if the comment is not.
Set to return true on error.
The x-akismet-debug-help header from the last operation, if any.
If the call returns neither true nor false, the x-akismet-debug-help header will provide context for any error that has occurred.
Note that the x-akismet-debug-help header will not always be sent if a response does not return false or true.
See the Akismet API for more details.
The error message.
The error (IO, empty response from Akismet, etc.) message is also logged as a warning.
Executes a call to an Akismet REST API method.
The Akismet API URL endpoint. (e.g. https://rest.akismet.com/1.1/verify-key)
The HTTP POST form body containing the request parameters to be submitted.
Set to return true on error (IO, empty response, etc.)
The HTTP status code of the last operation.
Provides access to the Akismet API.
The application user agent to be sent to Akismet.
The error message.
The HTTP status code of the last operation.
Set to true if Akismet has determined that the last checked comment is blatant spam, and you can safely discard it without saving it in any spam queue.
Set to true if the API Key has been verified.
Comment Check.
Executes a call to an Akismet REST API method.
Resets the debugHelp, errorMessage, httpStatusCode, isDiscard, isVerifiedKey, proTip, and response properties.
Submit Ham. (False Positives)
Submit Spam. (Missed Spam)
Set to true if Akismet has determined that the last checked comment is blatant spam, and you can safely discard it without saving it in any spam queue.
See the Akismet API for more details.
Set to true if the API Key has been verified.
The x-akismet-pro-tip header from the last operation, if any.
If the x-akismet-pro-tip header is set to discard, then Akismet has determined that the comment is blatant spam, and you can safely discard it without saving it in any spam queue.
See the Akismet API for more details.
Resets the debugHelp, errorMessage, httpStatusCode, isDiscard, isVerifiedKey, proTip, and response properties.
Submit Ham. (False Positives)
This call is intended for the submission of false positives - items that were incorrectly classified as spam by Akismet. It takes identical arguments as comment check and submit spam.
It is very important that the values you submit with this call match those of your comment check calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.
See the Akismet API for more details.
true if the comment was submitted, false otherwise.
Submit Spam. (Missed Spam)
This call is for submitting comments that weren't marked as spam but should have been.
It is very important that the values you submit with this call match those of your comment check calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.
See the Akismet API for more details.
true if the comment was submitted, false otherwise.
Key Verification.
Key verification authenticates your key before calling the comment check, submit spam, or submit ham methods. This is the first call that you should make to Akismet and is especially useful if you will have multiple users with their own Akismet subscriptions using your application.
See the Akismet API for more details.
true if the key is valid, false otherwise.
Sets the email address submitted with the comment.
Sets the character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1
Builds a new comment configuration.
Sets the UTC timestamp of the creation of the comment, in ISO 8601 format.
May be omitted if the comment is sent to the API at the time it is created.
Sets the mame submitted with the comment.
Sets the email address submitted with the comment.
Sets the URL submitted with comment.
Sets the character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1
Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.
Builds a new comment configuration.
Sets the content that was submitted.
Sets the UTC timestamp of the creation of the comment, in ISO 8601 format.
This is optional. You can set it when submitting test queries to Akismet.
Sets the full permanent URL of the entry the comment was submitted to.
Sets the UTC timestamp of the publication time for the post, page or thread on which the comment was posted.
If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.
Sets the content of the referrer header.
In PHP, there is an array of environmental variables called $_SERVER that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.
Sets a string that describes the type of content being sent, such as:
Sets the user agent string of the web browser submitting the comment.
Sets the IP address of the comment submitter.
Set the user role of the user who submitted the comment. This is an optional parameter.
Sets the UTC timestamp of the publication time for the post, page or thread on which the comment was posted.
If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.
For example: edit
In PHP, there is an array of environmental variables called $_SERVER that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.
How the submitted content interacts with the server can be very telling, so please include as much of it as possible.
Sets a string that describes the type of content being sent, such as:
You may send a value not listed above if none of them accurately describe your content.
This is further explained here.
Set the user role of the user who submitted the comment. This is an optional parameter.
If you set it to ADMIN_ROLE, Akismet will always return false.
IP address of the comment submitter.
User agent string of the web browser submitting the comment.
Provides a comment configuration.
IP address of the comment submitter.
User agent string of the web browser submitting the comment.
A blog post.
A blog comment.
A contact form or feedback form submission.
A top-level forum post.
A message sent between just a few users.
Undefined type.
A pingback.
A reply to a top-level forum post.
A new user account.
A trackback.
A Twitter message.
A blog post.
A blog comment.
A contact form or feedback form submission.
A top-level forum post.
A message sent between just a few users.
Undefined type.
A pingback.
A reply to a top-level forum post.
A new user account.
A trackback.
A Twitter message.
A Kotlin/Java library for accessing the Akismet service.
Provides access to the Akismet API.
A comment to send to Akismet.
Provides a comment configuration.
Defines the comment types.
Creates a new instance extracting the userIp, userAgent, referrer and serverEnv environment variables from a Servlet request.
See the Akismet API for more details.
Creates a new instance.
See the Akismet API for more details.
IP address of the comment submitter.
User agent string of the web browser submitting the comment.
Administrator role. If used, Akismet will always return false.
Email address submitted with the comment.
The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1
The UTC timestamp of the creation of the comment, in ISO 8601 format.
May be omitted if the comment is sent to the API at the time it is created.
A comment to send to Akismet.
Most everything is optional. Performance can drop dramatically if you choose to exclude data points. The more data you send Akismet about each comment, the greater the accuracy. They recommend erring on the side of including too much data.
See the Akismet API for more details.
IP address of the comment submitter.
User agent string of the web browser submitting the comment.
Email address submitted with the comment.
The character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1
The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.
If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.
A string that describes the type of content being sent, such as:
The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.
If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.
For example: edit
In PHP, there is an array of environmental variables called $_SERVER that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.
How the submitted content interacts with the server can be very telling, so please include as much of it as possible.
Returns a JSON representation of the comment.
Returns a JSON representation of the comment.
A string that describes the type of content being sent, such as:
You may send a value not listed above if none of them accurately describe your content.
This is further explained here.
The user role of the user who submitted the comment. This is an optional parameter.
If you set it to ADMIN_ROLE, Akismet will always return false.
Converts a date to a UTC timestamp. (ISO 8601)
Converts a locale date/time to a UTC timestamp. (ISO 8601)
(Re)Creates a comment from a JSON string.
The application user agent to be sent to Akismet.
If possible, the application user agent string should always use the following format:
Application Name/VersionThe library's own user agent string will automatically be appended.
See the Akismet API for more details.
Comment Check.
This is the call you will make the most. It takes a number of arguments and characteristics about the submitted content and then returns a thumbs up or thumbs down. Performance can drop dramatically if you choose to exclude data points. The more data you send Akismet about each comment, the greater the accuracy. They recommend erring on the side of including too much data
By default, if an error (IO, empty response from Akismet, etc.) occurs the function will return false and log the error, use the trueOnError parameter to change this behavior.
See the Akismet API for more details.
true if the comment is spam, false if the comment is not.
Set to return true on error.
The x-akismet-debug-help header from the last operation, if any.
If the call returns neither true nor false, the x-akismet-debug-help header will provide context for any error that has occurred.
Note that the x-akismet-debug-help header will not always be sent if a response does not return false or true.
See the Akismet API for more details.
The error message.
The error (IO, empty response from Akismet, etc.) message is also logged as a warning.
Executes a call to an Akismet REST API method.
The Akismet API URL endpoint. (e.g. https://rest.akismet.com/1.1/verify-key)
The HTTP POST form body containing the request parameters to be submitted.
Set to return true on error (IO, empty response, etc.)
The HTTP status code of the last operation.
Provides access to the Akismet API.
The application user agent to be sent to Akismet.
The error message.
The HTTP status code of the last operation.
Set to true if Akismet has determined that the last checked comment is blatant spam, and you can safely discard it without saving it in any spam queue.
Set to true if the API Key has been verified.
Comment Check.
Executes a call to an Akismet REST API method.
Resets the debugHelp, errorMessage, httpStatusCode, isDiscard, isVerifiedKey, proTip, and response properties.
Submit Ham. (False Positives)
Submit Spam. (Missed Spam)
Set to true if Akismet has determined that the last checked comment is blatant spam, and you can safely discard it without saving it in any spam queue.
See the Akismet API for more details.
The x-akismet-pro-tip header from the last operation, if any.
If the x-akismet-pro-tip header is set to discard, then Akismet has determined that the comment is blatant spam, and you can safely discard it without saving it in any spam queue.
See the Akismet API for more details.
Resets the debugHelp, errorMessage, httpStatusCode, isDiscard, isVerifiedKey, proTip, and response properties.
Submit Ham. (False Positives)
This call is intended for the submission of false positives - items that were incorrectly classified as spam by Akismet. It takes identical arguments as comment check and submit spam.
It is very important that the values you submit with this call match those of your comment check calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.
See the Akismet API for more details.
true if the comment was submitted, false otherwise.
Submit Spam. (Missed Spam)
This call is for submitting comments that weren't marked as spam but should have been.
It is very important that the values you submit with this call match those of your comment check calls as closely as possible. In order to learn from its mistakes, Akismet needs to match your missed spam and false positive reports to the original comment-check API calls made when the content was first posted. While it is normal for less information to be available for submit-spam and submit-ham calls (most comment systems and forums will not store all metadata), you should ensure that the values that you do send match those of the original content.
See the Akismet API for more details.
true if the comment was submitted, false otherwise.
Key Verification.
Key verification authenticates your key before calling the comment check, submit spam, or submit ham methods. This is the first call that you should make to Akismet and is especially useful if you will have multiple users with their own Akismet subscriptions using your application.
See the Akismet API for more details.
true if the key is valid, false otherwise.
Sets the email address submitted with the comment.
Sets the URL submitted with comment.
Sets the mame submitted with the comment.
Sets the character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1
Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.
A site with articles in English and French might use: en, fr_ca
Builds a new comment configuration.
Sets the content that was submitted.
Sets the UTC timestamp of the creation of the comment, in ISO 8601 format.
May be omitted if the comment is sent to the API at the time it is created.
Sets the mame submitted with the comment.
Sets the email address submitted with the comment.
Sets the URL submitted with comment.
Sets the character encoding for the form values included in comment parameters, such as UTF-8 or ISO-8859-1
Indicates the language(s) in use on the blog or site, in ISO 639-1 format, comma-separated.
Builds a new comment configuration.
Sets the content that was submitted.
Sets the UTC timestamp of the creation of the comment, in ISO 8601 format.
This is optional. You can set it when submitting test queries to Akismet.
Sets the full permanent URL of the entry the comment was submitted to.
Sets the UTC timestamp of the publication time for the post, page or thread on which the comment was posted.
If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.
Sets the content of the referrer header.
In PHP, there is an array of environmental variables called $_SERVER that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.
Sets a string that describes the type of content being sent, such as:
Sets the user agent string of the web browser submitting the comment.
Sets the IP address of the comment submitter.
Set the user role of the user who submitted the comment. This is an optional parameter.
This is optional. You can set it when submitting test queries to Akismet.
Sets the full permanent URL of the entry the comment was submitted to.
Sets the UTC timestamp of the publication time for the post, page or thread on which the comment was posted.
If you are sending content to Akismet to be rechecked, such as a post that has been edited or old pending comments that you'd like to recheck, include this parameter with a string describing why the content is being rechecked.
For example: edit
Sets the content of the referrer header.
In PHP, there is an array of environmental variables called $_SERVER that contains information about the Web server itself as well as a key/value for every HTTP header sent with the request. This data is highly useful to Akismet.
How the submitted content interacts with the server can be very telling, so please include as much of it as possible.
Sets a string that describes the type of content being sent, such as:
You may send a value not listed above if none of them accurately describe your content.
This is further explained here.
Sets the user agent string of the web browser submitting the comment.
User agent string of the web browser submitting the comment.
Sets the IP address of the comment submitter.
IP address of the comment submitter.
Set the user role of the user who submitted the comment. This is an optional parameter.
If you set it to ADMIN_ROLE, Akismet will always return false.
IP address of the comment submitter.
User agent string of the web browser submitting the comment.
Provides a comment configuration.
IP address of the comment submitter.
User agent string of the web browser submitting the comment.
A blog post.
A blog comment.
A contact form or feedback form submission.
A top-level forum post.
A message sent between just a few users.
Undefined type.
A pingback.
A reply to a top-level forum post.
A new user account.
A trackback.
A Twitter message.
A blog post.
A blog comment.
A contact form or feedback form submission.
A top-level forum post.
A message sent between just a few users.
Undefined type.
A pingback.
A reply to a top-level forum post.
A new user account.
A trackback.
A Twitter message.
Provides access to the Akismet API.
A comment to send to Akismet.
Provides a comment configuration.
Defines the comment types.