Sending Email From Workers: API Reference, Clarifications About Setup, DKIM, etc.

[cpsauer]

Which Cloudflare product does this pertain to?

Workers

Existing documentation URL(s)

https://developers.cloudflare.com/email-routing/email-workers/send-email-workers/

What changes are you suggesting?

Hi wonderful Cloudflare folks,

Being able to send emails from workers is indeed super helpful for getting alerts about worker activity. I know it's in Beta, and I think there are some improvement opportunities in the docs (and current APIs), so I figured I should write in.

The first is that I think the send() function could really use some API docs in addition to that example. (Forgive me if they're there and I missed them, but if not, the page linked above could use a link.) Otherwise it's hard to know what features are available when you're evaluating using the API!

The second is that I think most potential users will (or should) evaluate early whether the API will work with their email security measures, important for deliverability (DKIM, SPF, DMARC). It'd be great if the getting started docs would mention compatibility (or not) there.

The third (more generally) is that I think most people using this service (positioned to self-notify since destination emails have to be manually approved) might prefer more minimal setup at the cost of having the email come from, e.g., a Cloudflare address, especially in light of the complexity of configuring the DKIM-type stuff above. Similarly, it might save having to more fully enroll the domain in email routing if they're just using this one feature. If there's already a way to do that, maybe people could find it in the API docs you'd add, but it might also make a better getting started guide. (And if not, I think that'd make this feature way more easily useful!)

Finally, it'd be good to mention whether or not the email sending bindings can be configured from the dashboard--or just wrangler. I didn't see them in the dashboard (including when configured via wrangler), so I'm assuming not, but it'd be good to clarify the docs to save people time--or better yet, just add configurability/visibility from the dashboard.

Thanks for an exceptional product and for all you do! Chris