fix: don't wrap names in double-quotes (#408)

The backend has been updated to properly handling names with special characters so the original "fix" is no longer needed. Reverts #353
sendgrid · Sep 23, 2020 · 1aa7251 · 1aa7251
1 parent 22a6879
commit 1aa7251
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 98 deletions.
diff --git a/helpers/mail/mail_v3.go b/helpers/mail/mail_v3.go
@@ -4,7 +4,6 @@ import (
 	"encoding/json"
 	"log"
 	"net/mail"
-	"strings"
 )
 
 // SGMailV3 contains mail struct
@@ -604,35 +603,8 @@ func NewSetting(enable bool) *Setting {
 	return &Setting{Enable: &setEnable}
 }
 
-// EscapeName adds quotes around the name to prevent errors from RFC5322 special
-// characters:
-//
-//   ()<>[]:;@\,."
-//
-// To preserve backwards compatibility for people already quoting their name
-// inputs, as well as for inputs which do not strictly require quoting, the
-// name is returned unmodified if those conditions are met. Otherwise, existing
-// intrastring backslashes and double quotes are escaped, and the entire input
-// is surrounded with double quotes.
-func EscapeName(name string) string {
-	if len(name) > 1 && name[0] == '"' && name[len(name)-1] == '"' {
-		return name
-	}
-	if strings.IndexAny(name, "()<>[]:;@\\,.\"") == -1 {
-		return name
-	}
-
-	// This has to come first so we don't triple backslash after the next step
-	name = strings.Replace(name, `\`, `\\`, -1)
-	name = strings.Replace(name, `"`, `\"`, -1)
-	name = `"` + name + `"`
-
-	return name
-}
-
 // NewEmail ...
 func NewEmail(name string, address string) *Email {
-	name = EscapeName(name)
 	return &Email{
 		Name:    name,
 		Address: address,

diff --git a/helpers/mail/mail_v3_test.go b/helpers/mail/mail_v3_test.go
@@ -71,74 +71,28 @@ func TestV3AddAttachment(t *testing.T) {
 	assert.Equal(t, numOfAttachments, len(m.Attachments), fmt.Sprintf("Mail should have %d attachments, got %d attachments", numOfAttachments, len(m.Attachments)))
 }
 
-func TestEscapeName(t *testing.T) {
-	testcases := []struct {
-		title string
-		name  string
-		want  string
-	}{
-		{"contains double quote", `Johnny"Bravo`, `"Johnny\"Bravo"`},
-		{"contains backslash", `Johnny\Bravo`, `"Johnny\\Bravo"`},
-		{"contains open parens", `Johnny (Bravo`, `"Johnny (Bravo"`},
-		{"contains close parens", `Johnny Bravo)`, `"Johnny Bravo)"`},
-		{"contains open angle bracket", `Johnny <Bravo`, `"Johnny <Bravo"`},
-		{"contains open angle bracket", `Johnny Bravo>`, `"Johnny Bravo>"`},
-		{"contains open square bracket", `Johnny [Bravo`, `"Johnny [Bravo"`},
-		{"contains open square bracket", `Johnny Bravo]`, `"Johnny Bravo]"`},
-		{"contains colon", `Johnny:Bravo`, `"Johnny:Bravo"`},
-		{"contains semi-colon", `Johnny;Bravo`, `"Johnny;Bravo"`},
-		{"contains at sign", `Johnny@Bravo`, `"Johnny@Bravo"`},
-		{"contains comma", `Johnny,Bravo`, `"Johnny,Bravo"`},
-		{"contains period", `Johnny.Bravo`, `"Johnny.Bravo"`},
-	}
-	for _, tc := range testcases {
-		got := EscapeName(tc.name)
-		assert.Equal(t, tc.want, got, fmt.Sprintf("name should be %s, got %s", tc.want, got))
-	}
-}
-
 func TestV3SetFrom(t *testing.T) {
 	m := NewV3Mail()
 
-	testcases := []struct {
-		title string
-		name  string
-		want  string
-	}{
-		{"unquoted", `Test User`, `Test User`},
-		{"quoted", `"Test User"`, `"Test User"`},
-	}
-
 	address := "test@example.com"
-	for _, tc := range testcases {
-		e := NewEmail(tc.name, address)
-		m.SetFrom(e)
+	name := "Test User"
+	e := NewEmail(name, address)
+	m.SetFrom(e)
 
-		assert.Equal(t, tc.want, m.From.Name, fmt.Sprintf("name should be %s, got %s", tc.want, e.Name))
-		assert.Equal(t, address, m.From.Address, fmt.Sprintf("address should be %s, got %s", address, e.Address))
-	}
+	assert.Equal(t, name, m.From.Name, fmt.Sprintf("name should be %s, got %s", name, e.Name))
+	assert.Equal(t, address, m.From.Address, fmt.Sprintf("address should be %s, got %s", address, e.Address))
 }
 
 func TestV3SetReplyTo(t *testing.T) {
 	m := NewV3Mail()
 
-	testcases := []struct {
-		title string
-		name  string
-		want  string
-	}{
-		{"unquoted", `Test User`, `Test User`},
-		{"quoted", `"Test User"`, `"Test User"`},
-	}
-
 	address := "test@example.com"
-	for _, tc := range testcases {
-		e := NewEmail(tc.name, address)
-		m.SetReplyTo(e)
+	name := "Test User"
+	e := NewEmail(name, address)
+	m.SetReplyTo(e)
 
-		assert.Equal(t, tc.want, m.ReplyTo.Name, fmt.Sprintf("name should be %s, got %s", tc.want, e.Name))
-		assert.Equal(t, address, m.ReplyTo.Address, fmt.Sprintf("address should be %s, got %s", address, e.Address))
-	}
+	assert.Equal(t, name, m.ReplyTo.Name, fmt.Sprintf("name should be %s, got %s", name, e.Name))
+	assert.Equal(t, address, m.ReplyTo.Address, fmt.Sprintf("address should be %s, got %s", address, e.Address))
 }
 
 func TestV3SetTemplateID(t *testing.T) {
@@ -694,22 +648,13 @@ func TestV3NewSetting(t *testing.T) {
 }
 
 func TestV3NewEmail(t *testing.T) {
-	testcases := []struct {
-		title string
-		name  string
-		want  string
-	}{
-		{"unquoted", `Test User`, `Test User`},
-		{"quoted", `"Test User"`, `"Test User"`},
-	}
-
+	name := "Johnny"
 	address := "Johnny@rocket.io"
-	for _, tc := range testcases {
-		e := NewEmail(tc.name, address)
 
-		assert.Equal(t, tc.want, e.Name, fmt.Sprintf("Name should be %s, got %s", tc.want, e.Name))
-		assert.Equal(t, address, e.Address, fmt.Sprintf("Address should be %s, got %s", address, e.Address))
-	}
+	e := NewEmail(name, address)
+
+	assert.Equal(t, name, e.Name, fmt.Sprintf("Name should be %s, got %s", name, e.Name))
+	assert.Equal(t, address, e.Address, fmt.Sprintf("Address should be %s, got %s", address, e.Address))
 }
 
 func TestV3NewSingleEmail(t *testing.T) {