diff --git a/docs/thunderbird-oauth-example/README.md b/docs/thunderbird-oauth-example/README.md new file mode 100644 index 00000000..a7466bec --- /dev/null +++ b/docs/thunderbird-oauth-example/README.md @@ -0,0 +1,39 @@ +# Thunderbird OAuth Extension (Example) + +This folder contains a sample `manifest.json` for a Thunderbird OAuth provider extension. + +## 1. Update placeholders + +Edit [manifest.json](manifest.json) and replace all placeholders: + +- `` +- `` +- `` +- `` +- `` +- `` +- `` + +## 2. Create the extension package + +From this folder, run: + +```bash +zip -r thunderbird-oauth-provider.xpi manifest.json +``` + +This creates `thunderbird-oauth-provider.xpi`. + +## 3. Install in Thunderbird + +1. Open Thunderbird. +2. Go to **Add-ons and Themes**. +3. Click the gear icon and choose **Install Add-on From File...**. +4. Select `thunderbird-oauth-provider.xpi`. +5. Confirm prompts and restart Thunderbird if asked. + +## 4. Verify + +- Set account authentication to OAuth2. +- Trigger sign-in and complete the OAuth login flow. +- Confirm send/receive works. diff --git a/docs/thunderbird-oauth-example/manifest.json b/docs/thunderbird-oauth-example/manifest.json new file mode 100644 index 00000000..38040601 --- /dev/null +++ b/docs/thunderbird-oauth-example/manifest.json @@ -0,0 +1,21 @@ +{ + "manifest_version": 2, + "name": "", + "version": "1.0.0", + "applications": { + "gecko": { + "id": "oauth-provider@", + "strict_min_version": "128.0" + } + }, + "oauth_provider": { + "issuer": "", + "clientId": "", + "authorizationEndpoint": "", + "tokenEndpoint": "", + "redirectionEndpoint": "http://localhost", + "usePKCE": true, + "hostnames": [""], + "scopes": "openid email profile" + } +} \ No newline at end of file