@upyo/jmap 0.4.0 → 0.5.0-dev.81
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -17
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -9,14 +9,14 @@
|
|
|
9
9
|
[JMAP] transport for the [Upyo] email library. Implements [RFC 8620] (core)
|
|
10
10
|
and [RFC 8621] (mail) for sending emails via JMAP protocol.
|
|
11
11
|
|
|
12
|
-
[JSR]: https://jsr.io/@upyo/jmap
|
|
13
12
|
[JSR badge]: https://jsr.io/badges/@upyo/jmap
|
|
14
|
-
[
|
|
13
|
+
[JSR]: https://jsr.io/@upyo/jmap
|
|
15
14
|
[npm badge]: https://img.shields.io/npm/v/@upyo/jmap?logo=npm
|
|
15
|
+
[npm]: https://www.npmjs.com/package/@upyo/jmap
|
|
16
16
|
[JMAP]: https://jmap.io/
|
|
17
|
+
[Upyo]: https://upyo.org/
|
|
17
18
|
[RFC 8620]: https://www.rfc-editor.org/rfc/rfc8620
|
|
18
19
|
[RFC 8621]: https://www.rfc-editor.org/rfc/rfc8621
|
|
19
|
-
[Upyo]: https://upyo.org/
|
|
20
20
|
|
|
21
21
|
|
|
22
22
|
Features
|
|
@@ -81,23 +81,23 @@ Configuration
|
|
|
81
81
|
|
|
82
82
|
Either `bearerToken` or `basicAuth` must be provided:
|
|
83
83
|
|
|
84
|
-
| Option
|
|
85
|
-
|
|
86
|
-
| `sessionUrl`
|
|
87
|
-
| `bearerToken` | `string`
|
|
88
|
-
| `basicAuth`
|
|
84
|
+
| Option | Type | Description |
|
|
85
|
+
| ------------- | ---------------------------------------- | ---------------------------------------------------------- |
|
|
86
|
+
| `sessionUrl` | `string` | JMAP session URL (e.g., `https://server/.well-known/jmap`) |
|
|
87
|
+
| `bearerToken` | `string` | Bearer token for authentication |
|
|
88
|
+
| `basicAuth` | `{ username: string, password: string }` | Basic authentication credentials |
|
|
89
89
|
|
|
90
90
|
### Optional Options
|
|
91
91
|
|
|
92
|
-
| Option
|
|
93
|
-
|
|
94
|
-
| `accountId`
|
|
95
|
-
| `identityId`
|
|
96
|
-
| `timeout`
|
|
97
|
-
| `retries`
|
|
98
|
-
| `sessionCacheTtl` | `number`
|
|
99
|
-
| `headers`
|
|
100
|
-
| `baseUrl`
|
|
92
|
+
| Option | Type | Default | Description |
|
|
93
|
+
| ----------------- | ------------------------ | ------------- | ----------------------------------------------------------------------------------- |
|
|
94
|
+
| `accountId` | `string` | Auto-detected | JMAP account ID (defaults to first account with mail capability) |
|
|
95
|
+
| `identityId` | `string` | Auto-resolved | Identity ID for sending (defaults to identity matching sender email) |
|
|
96
|
+
| `timeout` | `number` | `30000` | Request timeout in milliseconds |
|
|
97
|
+
| `retries` | `number` | `3` | Number of retry attempts for failed requests |
|
|
98
|
+
| `sessionCacheTtl` | `number` | `300000` | Session cache TTL in milliseconds (5 minutes) |
|
|
99
|
+
| `headers` | `Record<string, string>` | `{}` | Additional HTTP headers to include in requests |
|
|
100
|
+
| `baseUrl` | `string` | - | Base URL for rewriting session URLs (useful when server returns internal hostnames) |
|
|
101
101
|
|
|
102
102
|
|
|
103
103
|
Error Handling
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@upyo/jmap",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0-dev.81+b3482a5e",
|
|
4
4
|
"description": "JMAP transport for Upyo email library",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"email",
|
|
@@ -53,7 +53,7 @@
|
|
|
53
53
|
},
|
|
54
54
|
"sideEffects": false,
|
|
55
55
|
"peerDependencies": {
|
|
56
|
-
"@upyo/core": "0.
|
|
56
|
+
"@upyo/core": "0.5.0-dev.81+b3482a5e"
|
|
57
57
|
},
|
|
58
58
|
"devDependencies": {
|
|
59
59
|
"@dotenvx/dotenvx": "^1.47.3",
|