Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature request: Verified senders endpoint #355

Open
lukebooroo opened this issue Dec 2, 2020 · 9 comments
Open

Feature request: Verified senders endpoint #355

lukebooroo opened this issue Dec 2, 2020 · 9 comments
Assignees
Labels
Enhancement New feature or request

Comments

@lukebooroo
Copy link

Hello,

Do you plan to support the verified senders endpoints?

https://sendgrid.api-docs.io/v3.0/sender-verification/domain-warn-list

:)

@Jericho
Copy link
Owner

Jericho commented Dec 4, 2020

Thanks for bringing this to my attention. Is this the new enhancement SendGrid announced in September 2020? It wasn't clear in the release notes that there was new API endpoints.

@Jericho
Copy link
Owner

Jericho commented Dec 4, 2020

I am a little confused though. What's the distinction between this new "verified senders" endpoint and the "sender identities" endpoint which StrongGrid already supports?

  • In both cases we can create sender identities
  • in both cases a email is sent to the configured email address for completing the verification

To make things more confusing, SendGrid apparently removed documentation for some of the endpoints in the old "sender identities" section. Only the "Create" endpoint is documented (there use to be a "Get" and "GetAll" endpoints as well):
image

Are they phasing out the old "sender identities" endpoints and replacing them with the new "verified senders"?

@Jericho Jericho self-assigned this Dec 4, 2020
@Jericho
Copy link
Owner

Jericho commented Dec 5, 2020

@Jericho
Copy link
Owner

Jericho commented Dec 5, 2020

I asked SendGrid for guidance on this. Let's see what they say.

@lukebooroo
Copy link
Author

Honestly, I'm not too sure. I've since tried using endpoint I wanted myself for retrieving a list of known DMARC domains. It only returned gmail.com and yahoo.com. Contacted sendgrid, it turns out they've not actually finished making it work 🤷‍♂️.

So instead for the meantime, I've made a method which will check the DMARC DNS TXT record of a given domain. Probably better this way.

@Jericho
Copy link
Owner

Jericho commented Dec 7, 2020

I did a quick comparison between "legacy sender identities" (which StrongGrid still supports but probably not for much longer), "sender identities" (which is what StrongGrid currently supports) and "sender verification" (which is the 'new' functionality you pointed out to me)

Method Description Legacy Sender Identities Sender Verification
Create Create a new sender identity
Get Retrieve a sender identity
GetAll Retrieve all the Sender Identities
Update Update an existing Sender Identity
Delete Delete a Sender Identity
Resend Resend a verification email to a specified Sender Identity
GetDomainWarnList Get a list of domains known to implement DMARC
GetCompletedSteps Determine which of SendGrid’s verification processes have been completed
VerifyRequest Verify a sender request

I did some testing over the weekend: I created a sender identity with the new endpoint and I did not detect any difference with a sender identity created with the 'sender identity' endpoint.

The new endpoints seem to support the basic functionality provided by the "old" endpoints (with the exception of Get but that can be easily worked around by invoking GetAll and filtering the result for the desired identity) and it seems to provide useful additional functionality such as update, delete, resend, etc.

All this to say that it probably make sense for StrongGrid to use the 'new' endpoints rather than the 'old' endpoints.

Having said that there just one thing that bothers me: the GetDomainWarnList method seems out of place. Since it returns a list of domains, I feel like it would make more sense to include this functionality in StrongGrid's SenderAuthentication resource which deals with domains rather that the SenderIdentities resource.

@lukebooroo
Copy link
Author

I think the reason that they've bundled it with verifying a single sender rather than a domain, is that you wouldn't allow someone to verify a single sender at a domain which implements DMARC. When verifying a domain you wouldn't need to check since you're adding to the DNS records.

@Jericho
Copy link
Owner

Jericho commented Dec 7, 2020

hummm. Makes sense so I'll leave the GetDomainWarnList with the SenderIdentities resource.

@Jericho
Copy link
Owner

Jericho commented Dec 11, 2020

While we wait for SendGrid's guidance, I took a stab at replacing the "Sender Identities" endpoints with the "Sender Verification" endpoints. I included a new method to retrieve the list of domains that are known to implement DMARC but I named the method "GetDmarcDomains" rather than "GetDomainWarnList". Let me know if you agree that this name is more clear,

I uploaded a prerelease package to my MyGet feed. It would be great if you could help me test it.

@Jericho Jericho added Enhancement New feature or request and removed New Feature labels Dec 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants