totole/services
1
0
Fork 0
mirror of https://github.com/kevin-DL/services.git synced 2026-01-11 19:04:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

integrate spam check on email (#270)

Browse Source
This commit is contained in:
Dominic Wong
2021-11-11 23:30:10 +00:00
committed by GitHub
parent 2e50bd5dc3
commit bfac5997d1
8 changed files with 121 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
spam/examples.json
View File

@@ -5,7 +5,7 @@
"run_check": true,
"request": {
"subject": "Welcome",
"email_body": "Hi there,\n\nWelcome to M3O.\n\nThanks\nM3O team",
"text_body": "Hi there,\n\nWelcome to M3O.\n\nThanks\nM3O team",
"from": "noreply@m3o.com",
"to": "hello@example.com"
},
@@ -18,6 +18,22 @@
"MISSING_MID, Missing Message-Id: header, 0.1"
]
}
},
{
"title": "Classify an email using the raw data",
"run_check": true,
"request": {
"email_body": "Subject: Welcome\r\nTo: hello@emaple.com\r\nFrom: noreply@m3o.com\r\n\r\nHi there,\n\nWelcome to M3O.\n\nThanks\nM3O team"
},
"response": {
"is_spam": false,
"score": 0.1,
"details": [
"NO_RELAYS, Informational: message was not relayed via SMTP, -0",
"NO_RECEIVED, Informational: message has no Received headers, -0",
"MISSING_MID, Missing Message-Id: header, 0.1"
]
}
}
]
}

48
spam/handler/spam.go
View File

@@ -1,11 +1,9 @@
package handler
import (
"bufio"
"bytes"
"context"
"fmt"
"net/textproto"
"time"
"github.com/Teamwork/spamc"
@@ -13,6 +11,7 @@ import (
"github.com/micro/micro/v3/service/errors"
log "github.com/micro/micro/v3/service/logger"
spam "github.com/micro/services/spam/proto"
"gopkg.in/gomail.v2"
)
type conf struct {
@@ -40,26 +39,39 @@ func New() *Spam {
}
func (s *Spam) Classify(ctx context.Context, request *spam.ClassifyRequest, response *spam.ClassifyResponse) error {
if len(request.EmailBody) == 0 {
return errors.BadRequest("spam.Classify", "missing email_body")
if len(request.EmailBody) == 0 && len(request.TextBody) == 0 && len(request.HtmlBody) == 0 {
return errors.BadRequest("spam.Classify", "Missing one of email_body, html_body, text_body")
}
bf := bytes.Buffer{}
bf := bytes.NewBufferString("")
tp := textproto.NewWriter(bufio.NewWriter(bf))
if len(request.EmailBody) > 0 {
bf.WriteString(request.EmailBody)
} else {
m := gomail.NewMessage()
if len(request.To) > 0 {
m.SetHeader("To", request.To)
}
if len(request.From) > 0 {
m.SetHeader("From", request.From)
}
if len(request.Subject) > 0 {
m.SetHeader("Subject", request.Subject)
}
m.SetHeader("Date", time.Now().Format(time.RFC1123Z))
if len(request.TextBody) > 0 {
m.SetBody("text/plain", request.TextBody)
}
if len(request.HtmlBody) > 0 {
m.SetBody("text/html", request.HtmlBody)
}
if _, err := m.WriteTo(&bf); err != nil {
log.Errorf("Error classifying email %s", err)
return errors.InternalServerError("spam.Classify", "Error classifying email")
}
if len(request.To) > 0 {
tp.PrintfLine("To: %v", request.To)
}
if len(request.From) > 0 {
tp.PrintfLine("From: %v", request.From)
}
if len(request.Subject) > 0 {
tp.PrintfLine("Subject: %v", request.Subject)
}
tp.PrintfLine("Date: %s", time.Now().Format(time.RFC1123Z))
tp.PrintfLine("")
tp.PrintfLine("%v", request.EmailBody)
rc, err := s.client.Report(ctx, bf, spamc.Header{}.Set("Content-Length", fmt.Sprintf("%d", bf.Len())))
rc, err := s.client.Report(ctx, &bf, spamc.Header{}.Set("Content-Length", fmt.Sprintf("%d", bf.Len())))
if err != nil {
log.Errorf("Error checking spamd %s", err)
return errors.InternalServerError("spam.Classify", "Error classifying email")

63
spam/proto/spam.pb.go
View File

@@ -26,7 +26,7 @@ type ClassifyRequest struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The body of the email
// The raw body of the email including headers etc per RFC 822. Alternatively, use the other parameters to correctly format the message
EmailBody string `protobuf:"bytes,1,opt,name=email_body,json=emailBody,proto3" json:"email_body,omitempty"`
// The email address it is being sent to
To string `protobuf:"bytes,2,opt,name=to,proto3" json:"to,omitempty"`
@@ -34,6 +34,10 @@ type ClassifyRequest struct {
From string `protobuf:"bytes,3,opt,name=from,proto3" json:"from,omitempty"`
// The subject of the email
Subject string `protobuf:"bytes,4,opt,name=subject,proto3" json:"subject,omitempty"`
// the plain text version of the email body
TextBody string `protobuf:"bytes,5,opt,name=text_body,json=textBody,proto3" json:"text_body,omitempty"`
// the HTML version of the email body
HtmlBody string `protobuf:"bytes,6,opt,name=html_body,json=htmlBody,proto3" json:"html_body,omitempty"`
}
func (x *ClassifyRequest) Reset() {
@@ -96,6 +100,20 @@ func (x *ClassifyRequest) GetSubject() string {
return ""
}
func (x *ClassifyRequest) GetTextBody() string {
if x != nil {
return x.TextBody
}
return ""
}
func (x *ClassifyRequest) GetHtmlBody() string {
if x != nil {
return x.HtmlBody
}
return ""
}
type ClassifyResponse struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
@@ -166,26 +184,29 @@ var File_proto_spam_proto protoreflect.FileDescriptor
var file_proto_spam_proto_rawDesc = []byte{
0x0a, 0x10, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x2f, 0x73, 0x70, 0x61, 0x6d, 0x2e, 0x70, 0x72, 0x6f,
0x74, 0x6f, 0x12, 0x04, 0x73, 0x70, 0x61, 0x6d, 0x22, 0x6e, 0x0a, 0x0f, 0x43, 0x6c, 0x61, 0x73,
0x73, 0x69, 0x66, 0x79, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1d, 0x0a, 0x0a, 0x65,
0x6d, 0x61, 0x69, 0x6c, 0x5f, 0x62, 0x6f, 0x64, 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52,
0x09, 0x65, 0x6d, 0x61, 0x69, 0x6c, 0x42, 0x6f, 0x64, 0x79, 0x12, 0x0e, 0x0a, 0x02, 0x74, 0x6f,
0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x02, 0x74, 0x6f, 0x12, 0x12, 0x0a, 0x04, 0x66, 0x72,
0x6f, 0x6d, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x66, 0x72, 0x6f, 0x6d, 0x12, 0x18,
0x0a, 0x07, 0x73, 0x75, 0x62, 0x6a, 0x65, 0x63, 0x74, 0x18, 0x04, 0x20, 0x01, 0x28, 0x09, 0x52,
0x07, 0x73, 0x75, 0x62, 0x6a, 0x65, 0x63, 0x74, 0x22, 0x5b, 0x0a, 0x10, 0x43, 0x6c, 0x61, 0x73,
0x73, 0x69, 0x66, 0x79, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x17, 0x0a, 0x07,
0x69, 0x73, 0x5f, 0x73, 0x70, 0x61, 0x6d, 0x18, 0x01, 0x20, 0x01, 0x28, 0x08, 0x52, 0x06, 0x69,
0x73, 0x53, 0x70, 0x61, 0x6d, 0x12, 0x14, 0x0a, 0x05, 0x73, 0x63, 0x6f, 0x72, 0x65, 0x18, 0x02,
0x20, 0x01, 0x28, 0x01, 0x52, 0x05, 0x73, 0x63, 0x6f, 0x72, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x64,
0x65, 0x74, 0x61, 0x69, 0x6c, 0x73, 0x18, 0x03, 0x20, 0x03, 0x28, 0x09, 0x52, 0x07, 0x64, 0x65,
0x74, 0x61, 0x69, 0x6c, 0x73, 0x32, 0x43, 0x0a, 0x04, 0x53, 0x70, 0x61, 0x6d, 0x12, 0x3b, 0x0a,
0x08, 0x43, 0x6c, 0x61, 0x73, 0x73, 0x69, 0x66, 0x79, 0x12, 0x15, 0x2e, 0x73, 0x70, 0x61, 0x6d,
0x2e, 0x43, 0x6c, 0x61, 0x73, 0x73, 0x69, 0x66, 0x79, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74,
0x1a, 0x16, 0x2e, 0x73, 0x70, 0x61, 0x6d, 0x2e, 0x43, 0x6c, 0x61, 0x73, 0x73, 0x69, 0x66, 0x79,
0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x00, 0x42, 0x0e, 0x5a, 0x0c, 0x2e, 0x2f,
0x70, 0x72, 0x6f, 0x74, 0x6f, 0x3b, 0x73, 0x70, 0x61, 0x6d, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74,
0x6f, 0x33,
0x74, 0x6f, 0x12, 0x04, 0x73, 0x70, 0x61, 0x6d, 0x22, 0xa8, 0x01, 0x0a, 0x0f, 0x43, 0x6c, 0x61,
0x73, 0x73, 0x69, 0x66, 0x79, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x1d, 0x0a, 0x0a,
0x65, 0x6d, 0x61, 0x69, 0x6c, 0x5f, 0x62, 0x6f, 0x64, 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09,
0x52, 0x09, 0x65, 0x6d, 0x61, 0x69, 0x6c, 0x42, 0x6f, 0x64, 0x79, 0x12, 0x0e, 0x0a, 0x02, 0x74,
0x6f, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x02, 0x74, 0x6f, 0x12, 0x12, 0x0a, 0x04, 0x66,
0x72, 0x6f, 0x6d, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x66, 0x72, 0x6f, 0x6d, 0x12,
0x18, 0x0a, 0x07, 0x73, 0x75, 0x62, 0x6a, 0x65, 0x63, 0x74, 0x18, 0x04, 0x20, 0x01, 0x28, 0x09,
0x52, 0x07, 0x73, 0x75, 0x62, 0x6a, 0x65, 0x63, 0x74, 0x12, 0x1b, 0x0a, 0x09, 0x74, 0x65, 0x78,
0x74, 0x5f, 0x62, 0x6f, 0x64, 0x79, 0x18, 0x05, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x65,
0x78, 0x74, 0x42, 0x6f, 0x64, 0x79, 0x12, 0x1b, 0x0a, 0x09, 0x68, 0x74, 0x6d, 0x6c, 0x5f, 0x62,
0x6f, 0x64, 0x79, 0x18, 0x06, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x68, 0x74, 0x6d, 0x6c, 0x42,
0x6f, 0x64, 0x79, 0x22, 0x5b, 0x0a, 0x10, 0x43, 0x6c, 0x61, 0x73, 0x73, 0x69, 0x66, 0x79, 0x52,
0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x17, 0x0a, 0x07, 0x69, 0x73, 0x5f, 0x73, 0x70,
0x61, 0x6d, 0x18, 0x01, 0x20, 0x01, 0x28, 0x08, 0x52, 0x06, 0x69, 0x73, 0x53, 0x70, 0x61, 0x6d,
0x12, 0x14, 0x0a, 0x05, 0x73, 0x63, 0x6f, 0x72, 0x65, 0x18, 0x02, 0x20, 0x01, 0x28, 0x01, 0x52,
0x05, 0x73, 0x63, 0x6f, 0x72, 0x65, 0x12, 0x18, 0x0a, 0x07, 0x64, 0x65, 0x74, 0x61, 0x69, 0x6c,
0x73, 0x18, 0x03, 0x20, 0x03, 0x28, 0x09, 0x52, 0x07, 0x64, 0x65, 0x74, 0x61, 0x69, 0x6c, 0x73,
0x32, 0x43, 0x0a, 0x04, 0x53, 0x70, 0x61, 0x6d, 0x12, 0x3b, 0x0a, 0x08, 0x43, 0x6c, 0x61, 0x73,
0x73, 0x69, 0x66, 0x79, 0x12, 0x15, 0x2e, 0x73, 0x70, 0x61, 0x6d, 0x2e, 0x43, 0x6c, 0x61, 0x73,
0x73, 0x69, 0x66, 0x79, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x16, 0x2e, 0x73, 0x70,
0x61, 0x6d, 0x2e, 0x43, 0x6c, 0x61, 0x73, 0x73, 0x69, 0x66, 0x79, 0x52, 0x65, 0x73, 0x70, 0x6f,
0x6e, 0x73, 0x65, 0x22, 0x00, 0x42, 0x0e, 0x5a, 0x0c, 0x2e, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f,
0x3b, 0x73, 0x70, 0x61, 0x6d, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33,
}
var (

6
spam/proto/spam.proto
View File

@@ -10,7 +10,7 @@ service Spam {
// Check whether an email is likely to be spam based on its attributes
message ClassifyRequest {
// The body of the email
// The raw body of the email including headers etc per RFC 822. Alternatively, use the other parameters to correctly format the message
string email_body = 1;
// The email address it is being sent to
string to = 2;
@@ -18,6 +18,10 @@ message ClassifyRequest {
string from = 3;
// The subject of the email
string subject = 4;
// the plain text version of the email body
string text_body = 5;
// the HTML version of the email body
string html_body = 6;
}
message ClassifyResponse {