Skip to content

Commit

Permalink
Remove redundant references to beta testing
Browse files Browse the repository at this point in the history
  • Loading branch information
axllent committed May 5, 2024
1 parent ebf7bb6 commit c81ea54
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 30 deletions.
11 changes: 4 additions & 7 deletions server/apiv1/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -727,7 +727,7 @@ func ReleaseMessage(w http.ResponseWriter, r *http.Request) {
func HTMLCheck(w http.ResponseWriter, r *http.Request) {
// swagger:route GET /api/v1/message/{ID}/html-check Other HTMLCheck
//
// # HTML check (beta)
// # HTML check
//
// Returns the summary of the message HTML checker.
//
Expand Down Expand Up @@ -780,7 +780,7 @@ func HTMLCheck(w http.ResponseWriter, r *http.Request) {
func LinkCheck(w http.ResponseWriter, r *http.Request) {
// swagger:route GET /api/v1/message/{ID}/link-check Other LinkCheck
//
// # Link check (beta)
// # Link check
//
// Returns the summary of the message Link checker.
//
Expand Down Expand Up @@ -831,12 +831,9 @@ func LinkCheck(w http.ResponseWriter, r *http.Request) {
func SpamAssassinCheck(w http.ResponseWriter, r *http.Request) {
// swagger:route GET /api/v1/message/{ID}/sa-check Other SpamAssassinCheck
//
// # SpamAssassin check (beta)
// # SpamAssassin check
//
// Returns the SpamAssassin (if enabled) summary of the message.
//
// NOTE: This feature is currently in beta and is documented for reference only.
// Please do not integrate with it (yet) as there may be changes.
// Returns the SpamAssassin summary (if enabled) of the message.
//
// Produces:
// - application/json
Expand Down
39 changes: 20 additions & 19 deletions server/ui-src/components/message/SpamAssassin.vue
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ export default {
]
},
scoreColor: function() {
scoreColor: function () {
return this.graphSections[0].color
},
}
Expand Down Expand Up @@ -206,10 +206,6 @@ export default {
<button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
</div>
<div class="modal-body">
<p>
Spam Analysis is currently in beta. Constructive feedback is welcome via
<a href="https://github.com/axllent/mailpit/issues" target="_blank">GitHub</a>.
</p>
<div class="accordion" id="SpamAnalysisAboutAccordion">
<div class="accordion-item">
<h2 class="accordion-header">
Expand All @@ -218,13 +214,14 @@ export default {
What is Spam Analysis?
</button>
</h2>
<div id="col1" class="accordion-collapse collapse" data-bs-parent="#SpamAnalysisAboutAccordion">
<div id="col1" class="accordion-collapse collapse"
data-bs-parent="#SpamAnalysisAboutAccordion">
<div class="accordion-body">
<p>
Mailpit integrates with SpamAssassin to provide you with some insight into the
"spamminess" of your messages. It sends your complete message (including any
attachments) to a running SpamAssassin server and then displays the results returned
by SpamAssassin.
attachments) to a running SpamAssassin server and then displays the results
returned by SpamAssassin.
</p>
</div>
</div>
Expand All @@ -236,16 +233,17 @@ export default {
How does the point system work?
</button>
</h2>
<div id="col2" class="accordion-collapse collapse" data-bs-parent="#SpamAnalysisAboutAccordion">
<div id="col2" class="accordion-collapse collapse"
data-bs-parent="#SpamAnalysisAboutAccordion">
<div class="accordion-body">
<p>
The default spam threshold is <code>5</code>, meaning any score lower than 5 is
considered ham (not spam), and any score of 5 or above is spam.
</p>
<p>
SpamAssassin will also return the tests which are triggered by the message. These
tests can differ depending on the configuration of your SpamAssassin server. The
total of this score makes up the the "spamminess" of the message.
SpamAssassin will also return the tests which are triggered by the message.
These tests can differ depending on the configuration of your SpamAssassin
server. The total of this score makes up the the "spamminess" of the message.
</p>
</div>
</div>
Expand All @@ -257,16 +255,18 @@ export default {
But I don't agree with the results...
</button>
</h2>
<div id="col3" class="accordion-collapse collapse" data-bs-parent="#SpamAnalysisAboutAccordion">
<div id="col3" class="accordion-collapse collapse"
data-bs-parent="#SpamAnalysisAboutAccordion">
<div class="accordion-body">
<p>
Mailpit does not manipulate the results nor determine the "spamminess" of
your message. The result is what SpamAssassin returns, and it entirely
dependent on how SpamAssassin is set up and optionally trained.
</p>
<p>
This tool is simply provided as an aid to assist you. If you are running your own
instance of SpamAssassin, then you look into your SpamAssassin configuration.
This tool is simply provided as an aid to assist you. If you are running your
own instance of SpamAssassin, then you look into your SpamAssassin
configuration.
</p>
</div>
</div>
Expand All @@ -278,14 +278,15 @@ export default {
Where can I find more information about the triggered rules?
</button>
</h2>
<div id="col4" class="accordion-collapse collapse" data-bs-parent="#SpamAnalysisAboutAccordion">
<div id="col4" class="accordion-collapse collapse"
data-bs-parent="#SpamAnalysisAboutAccordion">
<div class="accordion-body">
<p>
Unfortunately the current <a href="https://spamassassin.apache.org/"
target="_blank">SpamAssassin website</a> no longer contains any relative
documentation
about these, most likely because the rules come from different locations and change
often. You will need to search the internet for these yourself.
documentation about these, most likely because the rules come from different
locations and change often. You will need to search the internet for these
yourself.
</p>
</div>
</div>
Expand Down
8 changes: 4 additions & 4 deletions server/ui/api/v1/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
"tags": [
"Other"
],
"summary": "HTML check (beta)",
"summary": "HTML check",
"operationId": "HTMLCheck",
"parameters": [
{
Expand Down Expand Up @@ -172,7 +172,7 @@
"tags": [
"Other"
],
"summary": "Link check (beta)",
"summary": "Link check",
"operationId": "LinkCheck",
"parameters": [
{
Expand Down Expand Up @@ -368,7 +368,7 @@
},
"/api/v1/message/{ID}/sa-check": {
"get": {
"description": "Returns the SpamAssassin (if enabled) summary of the message.\n\nNOTE: This feature is currently in beta and is documented for reference only.\nPlease do not integrate with it (yet) as there may be changes.",
"description": "Returns the SpamAssassin summary (if enabled) of the message.",
"produces": [
"application/json"
],
Expand All @@ -379,7 +379,7 @@
"tags": [
"Other"
],
"summary": "SpamAssassin check (beta)",
"summary": "SpamAssassin check",
"operationId": "SpamAssassinCheck",
"parameters": [
{
Expand Down

0 comments on commit c81ea54

Please sign in to comment.