chore: Remove mail.send helpers with on-behalf-of header #436
Conversation
The sendgrid documentation (and my own findings) say that the mail.send endpoint does not support using the `on-behalf-of` header. [Documentation]( https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of-subuser ) Providing the `NewSendClientSubuser` in this SDK causes wasted time because it sets the expectation that this is possible when it is not. I also added guards to the `GetRequestSubuser` function to prevent people from using it with the mail.send endpoint.
thinkingserious
added
the
status: code review request
sendgrid.go
Outdated
| @@ -21,6 +23,10 @@ func GetRequest(key, endpoint, host string) rest.Request { | |||
| // GetRequestSubuser like GetRequest but with On-Behalf of Subuser | |||
| // @return [Request] a default request object | |||
| func GetRequestSubuser(key, endpoint, host, subuser string) rest.Request { | |||
| if strings.Contains(endpoint, "v3/mail/send") { | |||
There was a problem hiding this comment.
Does using the on-behalf-of with this endpoint throw any error at all? I'm not too sure I like hardcoding this into the logic here.
There was a problem hiding this comment.
It does not throw an error, it just silently "fails" by ignoring the header and putting the email on the subuser who owns the API key.
There was a problem hiding this comment.
(My primary motivation for this change was so that there would be something to test to guard against someone adding this functionality back in)
There was a problem hiding this comment.
I am ok with getting rid of NewSendClientSubuser and updating the documentation since that's not really supported but I don't like adding this hardcoded panic.
There was a problem hiding this comment.
@shwetha-manvinkurke Done
JenniferMah
changed the title
The sendgrid documentation (and my own findings) say that the mail.send endpoint
does not support using the
on-behalf-ofheader.Documentation
Providing the
NewSendClientSubuserin this SDK causes wasted time because itsets the expectation that this is possible when it is not.
I also added guards to the
GetRequestSubuserfunction to prevent people fromusing it with the mail.send endpoint.
Fixes
A short description of what this PR does.
Checklist