Sync docs for agents PR #800: update dependencies #27895
+47
−9
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update documentation to reflect that email forward() and reply() methods now return Promise<EmailSendResult> instead of Promise<void>. This change corresponds to agents PR #800 which updates dependencies including @cloudflare/workers-types. Changes: - Updated AgentEmail interface documentation in agents/concepts/agent-class.mdx - Added examples showing how to use the returned messageId - Updated ForwardableEmailMessage interface in email-routing runtime API - Added EmailSendResult type definition Related: cloudflare/agents#800
agents-git-bot
bot
requested review from
a team,
elithrar,
irvinebroque,
rita3ko,
thomasgauvin,
threepointone and
whoiskatrin
as code owners
github-actions
bot
added
product:email-routing
product:agents
github-actions
bot
assigned
elithrar,
irvinebroque,
rita3ko,
thomasgauvin,
threepointone and
whoiskatrin
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR syncs documentation changes for cloudflare/agents#800 which updates dependencies.
Changes
The dependency update includes an upgrade to
@cloudflare/workers-typeswhich introduces a breaking change to the Email Worker API. Theforward()andreply()methods on email messages now returnPromise<EmailSendResult>instead ofPromise<void>, whereEmailSendResultcontains amessageIdfield for tracking sent emails.Updated Documentation
AgentEmailemail handling examples to show the returnedEmailSendResultand how to use themessageIdForwardableEmailMessageinterface to show new return typesEmailSendResulttype definitionmessageIdRelated PR
🤖 Auto-generated by the docs sync workflow