DE-1388 (mg *MailgunImpl) Send should accept interface, not struct (#368

) https://bryanftan.medium.com/accept-interfaces-return-structs-in-go-d4cab29a301b
mailgun · Dec 15, 2024 · a2a4cfd · a2a4cfd
1 parent 34b51e0
commit a2a4cfd
Show file tree

Hide file tree

Showing 12 changed files with 156 additions and 213 deletions.
diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ func main() {
 	recipient := "[email protected]"
 
 	// The message object allows you to add attachments and Bcc recipients
-	message := mailgun.NewMessage(sender, subject, body, recipient)
+	message := mailgun.NewMessage(yourDomain, sender, subject, body, recipient)
 
 	ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
 	defer cancel()
@@ -290,7 +290,7 @@ func main() {
 	subject := "HTML email!"
 	recipient := "[email protected]"
 
-	message := mailgun.NewMessage(sender, subject, "", recipient)
+	message := mailgun.NewMessage(yourDomain, sender, subject, "", recipient)
 	body := `
 <html>
 <body>
@@ -351,7 +351,7 @@ func main() {
 	recipient := "[email protected]"
 
 	// The message object allows you to add attachments and Bcc recipients
-	message := mailgun.NewMessage(sender, subject, body, recipient)
+	message := mailgun.NewMessage(yourDomain, sender, subject, body, recipient)
 	message.SetTemplate("passwordReset")
 	err := message.AddTemplateVariable("passwordResetLink", "some link to your site unique to your user")
 	if err != nil {

diff --git a/attachments_test.go b/attachments_test.go
@@ -31,7 +31,7 @@ func TestMultipleAttachments(t *testing.T) {
 
 	var ctx = context.Background()
 
-	m := mailgun.NewMessage("root@"+testDomain, "Subject", "Text Body", "attachment@"+testDomain)
+	m := mailgun.NewMessage(testDomain, "root@"+testDomain, "Subject", "Text Body", "attachment@"+testDomain)
 
 	// Add 2 attachments
 	m.AddAttachment(createAttachment(t))

diff --git a/events_test.go b/events_test.go
@@ -87,7 +87,7 @@ func TestEventPoller(t *testing.T) {
 	}()
 
 	// Send an email
-	m := mailgun.NewMessage("root@"+testDomain, "Subject", "Text Body", "user@"+testDomain)
+	m := mailgun.NewMessage(testDomain, "root@"+testDomain, "Subject", "Text Body", "user@"+testDomain)
 	msg, id, err := mg.Send(ctx, m)
 	require.NoError(t, err)
 

diff --git a/examples/examples.go b/examples/examples.go
@@ -779,7 +779,7 @@ func SendMimeMessage(domain, apiKey string) (string, error) {
 		return "", err
 	}
 
-	m := mailgun.NewMIMEMessage(mimeMsgReader, "[email protected]")
+	m := mailgun.NewMIMEMessage(domain, mimeMsgReader, "[email protected]")
 
 	ctx, cancel := context.WithTimeout(context.Background(), time.Second*30)
 	defer cancel()
@@ -824,6 +824,7 @@ func SendSimpleMessage(domain, apiKey string) (string, error) {
 func SendTaggedMessage(domain, apiKey string) (string, error) {
 	mg := mailgun.NewMailgun(domain, apiKey)
 	m := mailgun.NewMessage(
+		domain,
 		"Excited User <YOU@YOUR_DOMAIN_NAME>",
 		"Hello",
 		"Testing some Mailgun awesomeness!",
@@ -845,6 +846,7 @@ func SendTaggedMessage(domain, apiKey string) (string, error) {
 func SendTemplateMessage(domain, apiKey string) (string, error) {
 	mg := mailgun.NewMailgun(domain, apiKey)
 	m := mailgun.NewMessage(
+		domain,
 		"Excited User <YOU@YOUR_DOMAIN_NAME>",
 		"Hey %recipient.first%",
 		"If you wish to unsubscribe, click http://mailgun/unsubscribe/%recipient.id%",
@@ -939,7 +941,7 @@ func SendMessageWithTemplate(domain, apiKey string) error {
 	time.Sleep(time.Second * 1)
 
 	// Create a new message with template
-	m := mailgun.NewMessage("Excited User <[email protected]>", "Template example", "")
+	m := mailgun.NewMessage(domain, "Excited User <[email protected]>", "Template example", "")
 	m.SetTemplate("my-template")
 
 	// Add recipients

diff --git a/examples_test.go b/examples_test.go
@@ -112,7 +112,7 @@ Testing some Mailgun MIME awesomeness!
 	defer cancel()
 
 	mg := mailgun.NewMailgun("example.com", "my_api_key")
-	m := mailgun.NewMIMEMessage(io.NopCloser(strings.NewReader(exampleMime)), "[email protected]")
+	m := mailgun.NewMIMEMessage("example.com", io.NopCloser(strings.NewReader(exampleMime)), "[email protected]")
 	_, id, err := mg.Send(ctx, m)
 	if err != nil {
 		log.Fatal(err)

diff --git a/mailgun.go b/mailgun.go
@@ -139,9 +139,8 @@ type Mailgun interface {
 	AddOverrideHeader(k string, v string)
 	GetCurlOutput() string
 
-	// Send attempts to queue a message (see Message, NewMessage, and its methods) for delivery.
-	// TODO(v5): switch m to SendableMessage interface
-	Send(ctx context.Context, m *Message) (mes string, id string, err error)
+	// Send attempts to queue a message (see CommonMessage, NewMessage, and its methods) for delivery.
+	Send(ctx context.Context, m SendableMessage) (mes string, id string, err error)
 	ReSend(ctx context.Context, id string, recipients ...string) (string, string, error)
 
 	ListBounces(opts *ListOptions) *BouncesIterator