Skip to content

Clarify Appwrite Auth email policies Cloud availability#3085

Open
atharva-appwrite wants to merge 1 commit into
mainfrom
docs/cloud-email-policies
Open

Clarify Appwrite Auth email policies Cloud availability#3085
atharva-appwrite wants to merge 1 commit into
mainfrom
docs/cloud-email-policies

Conversation

@atharva-appwrite

Copy link
Copy Markdown

Summary

  • Clarify that Auth email policies are currently available on Appwrite Cloud only
  • Add the availability note to the main email policies docs and related Auth/security docs
  • Scope the Project service reference description so email-policy updates do not imply self-hosted availability

Validation

  • git diff --check
  • Prettier was not run because local dependencies and bunx are not available in this environment

@appwrite

appwrite Bot commented Jul 6, 2026

Copy link
Copy Markdown

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Ready Ready View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Processing Processing View Logs Preview URL QR Code


Tip

MCP server integration brings LLM superpowers to Claude Desktop and Cursor IDE

@greptile-apps

greptile-apps Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR adds Cloud-only availability notices for the email-policies feature across six documentation files, ensuring self-hosted users are not misled into expecting Console controls or Project service API endpoints that are not shipped in self-hosted Appwrite. The changes are purely editorial with no code impact.

  • Six docs pages updated consistently to prefix email-policy descriptions with an "Appwrite Cloud only" qualifier; the dedicated email-policies page also gains an {% info %} callout.
  • The Project service reference description is split so the Cloud-scoped email-policy sentence is clearly separated from the general-purpose description.

Confidence Score: 4/5

Safe to merge — all changes are documentation text with no effect on runtime behavior.

The availability notices are applied consistently and correctly across all six files. Two minor wording opportunities exist: the info callout in the email-policies page mentions only the Console when clarifying self-hosted absence (leaving the API path ambiguous), and a pronoun in project.md is slightly ambiguous — but neither affects correctness or user safety in a meaningful way.

The {% info %} callout in src/routes/docs/products/auth/email-policies/+page.markdoc and the final sentence in src/routes/docs/references/[version]/[platform]/[service]/descriptions/project.md are worth a quick read before merging.

Important Files Changed

Filename Overview
src/routes/docs/products/auth/email-policies/+page.markdoc Added Cloud-only availability statement and an {% info %} callout; the callout's second sentence names only the Console, leaving the API path ambiguous for self-hosted users.
src/partials/auth-security.md Added "currently available on Appwrite Cloud only" qualifier consistently across both the description and the configuration sentence.
src/routes/docs/advanced/security/abuse-protection/+page.markdoc Added "currently available on Appwrite Cloud only" to the email-policies section intro; change is accurate and minimal.
src/routes/docs/products/auth/accounts/+page.markdoc Prefixed the email-policies link sentence with "On Appwrite Cloud" and removed a trailing blank line; straightforward and correct.
src/routes/docs/products/auth/email-password/+page.markdoc Added "On Appwrite Cloud" qualifier before the email-policies mention in the intro paragraph; clean single-sentence change.
src/routes/docs/references/[version]/[platform]/[service]/descriptions/project.md Split the last sentence into two; the pronoun "it" in the new sentence is slightly ambiguous, though context makes it clear it refers to the Project service.

Reviews (1): Last reviewed commit: "Clarify email policies Cloud availabilit..." | Re-trigger Greptile

Comment on lines +9 to +11
{% info title="Availability" %}
Email policies are not available in self-hosted Appwrite deployments. In self-hosted projects, the Appwrite Console does not show the email-policy controls.
{% /info %}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 The callout's second sentence narrows the "not available" statement to only the Console UI, which could lead a self-hosted developer to assume that the Project service API calls still work on their instance. Since the feature is entirely absent from self-hosted deployments, mentioning both surfaces avoids that confusion.

Suggested change
{% info title="Availability" %}
Email policies are not available in self-hosted Appwrite deployments. In self-hosted projects, the Appwrite Console does not show the email-policy controls.
{% /info %}
{% info title="Availability" %}
Email policies are not available in self-hosted Appwrite deployments. In self-hosted projects, the Appwrite Console does not show the email-policy controls, and the Project service API calls for email policies are not supported.
{% /info %}

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Register new client platforms such as [Web](/docs/references/1.9.x/server-nodejs/project#createWebPlatform), [Apple](/docs/references/1.9.x/server-nodejs/project#createApplePlatform), and [Android](/docs/references/1.9.x/server-nodejs/project#createAndroidPlatform) so your applications can securely communicate with the Appwrite API. Create, update, and revoke [API keys](/docs/references/1.9.x/server-nodejs/project#createKey) to control server-to-server access with the exact scopes your integrations need.

This service also lets you manage [project variables](/docs/references/1.9.x/server-nodejs/project#createVariable) that are available to all your functions and sites, and update email-handling preferences such as disposable, free, and canonical email policies for your project.
This service also lets you manage [project variables](/docs/references/1.9.x/server-nodejs/project#createVariable) that are available to all your functions and sites. On Appwrite Cloud, it can also update email-handling preferences such as disposable, free, and canonical email policies for your project.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 The pronoun "it" in the new sentence could be read as referring to "Appwrite Cloud" rather than "the Project service". Making the subject explicit keeps the sentence unambiguous for readers landing on the API reference directly.

Suggested change
This service also lets you manage [project variables](/docs/references/1.9.x/server-nodejs/project#createVariable) that are available to all your functions and sites. On Appwrite Cloud, it can also update email-handling preferences such as disposable, free, and canonical email policies for your project.
This service also lets you manage [project variables](/docs/references/1.9.x/server-nodejs/project#createVariable) that are available to all your functions and sites. On Appwrite Cloud, the Project service can also update email-handling preferences such as disposable, free, and canonical email policies for your project.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant