agentmail 0.5.46 → 0.5.48
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/dist/cjs/BaseClient.js +2 -2
- package/dist/cjs/api/resources/agent/client/Client.d.ts +3 -1
- package/dist/cjs/api/resources/agent/client/Client.js +3 -1
- package/dist/cjs/api/resources/apiKeys/types/ApiKeyPermissions.d.ts +4 -4
- package/dist/cjs/api/resources/calendar/types/IanaTimezone.d.ts +5 -3
- package/dist/cjs/api/resources/domains/types/Domain.d.ts +11 -4
- package/dist/cjs/api/resources/domains/types/RecordType.d.ts +1 -0
- package/dist/cjs/api/resources/domains/types/RecordType.js +1 -0
- package/dist/cjs/api/resources/domains/types/TrackingEnabled.d.ts +4 -3
- package/dist/cjs/api/resources/domains/types/TrackingStatus.d.ts +10 -0
- package/dist/cjs/api/resources/domains/types/TrackingStatus.js +3 -0
- package/dist/cjs/api/resources/domains/types/UpdateDomainRequest.d.ts +2 -1
- package/dist/cjs/api/resources/domains/types/VerificationRecord.d.ts +1 -1
- package/dist/cjs/api/resources/domains/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/domains/types/index.js +1 -0
- package/dist/cjs/api/resources/events/types/EventId.d.ts +3 -1
- package/dist/cjs/api/resources/events/types/InboxIds.d.ts +1 -1
- package/dist/cjs/api/resources/events/types/MessageReceivedEvent.d.ts +1 -1
- package/dist/cjs/api/resources/events/types/PodIds.d.ts +1 -1
- package/dist/cjs/api/resources/events/types/ReceivedMessage.d.ts +18 -0
- package/dist/cjs/api/resources/events/types/ReceivedMessage.js +3 -0
- package/dist/cjs/api/resources/events/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/events/types/index.js +1 -0
- package/dist/cjs/api/resources/inboxes/client/Client.d.ts +2 -1
- package/dist/cjs/api/resources/inboxes/client/Client.js +2 -1
- package/dist/cjs/api/resources/inboxes/resources/calendar/client/Client.d.ts +20 -21
- package/dist/cjs/api/resources/inboxes/resources/calendar/client/Client.js +20 -21
- package/dist/cjs/api/resources/inboxes/types/CreateInboxRequest.d.ts +2 -0
- package/dist/cjs/api/resources/inboxes/types/Inbox.d.ts +5 -0
- package/dist/cjs/api/resources/inboxes/types/PauseAt.d.ts +7 -0
- package/dist/cjs/api/resources/inboxes/types/PauseAt.js +3 -0
- package/dist/cjs/api/resources/inboxes/types/UpdateInboxRequest.d.ts +7 -1
- package/dist/cjs/api/resources/inboxes/types/index.d.ts +1 -0
- package/dist/cjs/api/resources/inboxes/types/index.js +1 -0
- package/dist/cjs/api/resources/messages/types/Message.d.ts +1 -0
- package/dist/cjs/api/resources/messages/types/MessageAuthenticationDomain.d.ts +5 -0
- package/dist/cjs/api/resources/messages/types/MessageAuthenticationDomain.js +3 -0
- package/dist/cjs/api/resources/messages/types/MessageAuthenticationResults.d.ts +56 -0
- package/dist/cjs/api/resources/messages/types/MessageAuthenticationResults.js +3 -0
- package/dist/cjs/api/resources/messages/types/MessageAuthenticationVerdict.d.ts +16 -0
- package/dist/cjs/api/resources/messages/types/MessageAuthenticationVerdict.js +19 -0
- package/dist/cjs/api/resources/messages/types/MessageCalendarEventId.d.ts +3 -2
- package/dist/cjs/api/resources/messages/types/MessageHeaders.d.ts +4 -1
- package/dist/cjs/api/resources/messages/types/MessageItem.d.ts +1 -0
- package/dist/cjs/api/resources/messages/types/index.d.ts +3 -0
- package/dist/cjs/api/resources/messages/types/index.js +3 -0
- package/dist/cjs/api/resources/metrics/client/Client.d.ts +3 -4
- package/dist/cjs/api/resources/metrics/client/Client.js +3 -4
- package/dist/cjs/api/resources/organizations/client/Client.d.ts +1 -1
- package/dist/cjs/api/resources/organizations/client/Client.js +1 -1
- package/dist/cjs/api/resources/organizations/types/Organization.d.ts +12 -0
- package/dist/cjs/api/resources/webhooks/types/CreatePodWebhookRequest.d.ts +4 -0
- package/dist/cjs/api/resources/webhooks/types/CreateWebhookEventTypes.d.ts +3 -2
- package/dist/cjs/api/resources/webhooks/types/CreateWebhookRequest.d.ts +3 -2
- package/dist/cjs/api/resources/webhooks/types/UpdateInboxWebhookRequest.d.ts +6 -4
- package/dist/cjs/api/resources/webhooks/types/UpdatePodWebhookRequest.d.ts +2 -1
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookEventTypes.d.ts +2 -2
- package/dist/cjs/api/resources/webhooks/types/UpdateWebhookRequest.d.ts +4 -1
- package/dist/cjs/api/resources/webhooks/types/Webhook.d.ts +5 -1
- package/dist/cjs/serialization/resources/domains/types/Domain.d.ts +3 -0
- package/dist/cjs/serialization/resources/domains/types/Domain.js +3 -0
- package/dist/cjs/serialization/resources/domains/types/RecordType.d.ts +1 -1
- package/dist/cjs/serialization/resources/domains/types/RecordType.js +1 -1
- package/dist/cjs/serialization/resources/domains/types/TrackingStatus.d.ts +8 -0
- package/dist/cjs/serialization/resources/domains/types/TrackingStatus.js +6 -0
- package/dist/cjs/serialization/resources/domains/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/domains/types/index.js +1 -0
- package/dist/cjs/serialization/resources/events/types/MessageReceivedEvent.d.ts +2 -2
- package/dist/cjs/serialization/resources/events/types/MessageReceivedEvent.js +2 -2
- package/dist/cjs/serialization/resources/events/types/ReceivedMessage.d.ts +11 -0
- package/dist/cjs/serialization/resources/events/types/ReceivedMessage.js +45 -0
- package/dist/cjs/serialization/resources/events/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/events/types/index.js +1 -0
- package/dist/cjs/serialization/resources/inboxes/types/CreateInboxRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/CreateInboxRequest.js +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/Inbox.d.ts +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/Inbox.js +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/PauseAt.d.ts +7 -0
- package/dist/cjs/serialization/resources/inboxes/types/PauseAt.js +39 -0
- package/dist/cjs/serialization/resources/inboxes/types/UpdateInboxRequest.d.ts +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/UpdateInboxRequest.js +2 -0
- package/dist/cjs/serialization/resources/inboxes/types/index.d.ts +1 -0
- package/dist/cjs/serialization/resources/inboxes/types/index.js +1 -0
- package/dist/cjs/serialization/resources/messages/types/Message.d.ts +2 -0
- package/dist/cjs/serialization/resources/messages/types/Message.js +2 -0
- package/dist/cjs/serialization/resources/messages/types/MessageAuthenticationDomain.d.ts +7 -0
- package/dist/cjs/serialization/resources/messages/types/MessageAuthenticationDomain.js +39 -0
- package/dist/cjs/serialization/resources/messages/types/MessageAuthenticationResults.d.ts +17 -0
- package/dist/cjs/serialization/resources/messages/types/MessageAuthenticationResults.js +49 -0
- package/dist/cjs/serialization/resources/messages/types/MessageAuthenticationVerdict.d.ts +7 -0
- package/dist/cjs/serialization/resources/messages/types/MessageAuthenticationVerdict.js +39 -0
- package/dist/cjs/serialization/resources/messages/types/MessageItem.d.ts +2 -0
- package/dist/cjs/serialization/resources/messages/types/MessageItem.js +2 -0
- package/dist/cjs/serialization/resources/messages/types/index.d.ts +3 -0
- package/dist/cjs/serialization/resources/messages/types/index.js +3 -0
- package/dist/cjs/serialization/resources/organizations/types/Organization.d.ts +2 -0
- package/dist/cjs/serialization/resources/organizations/types/Organization.js +2 -0
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.mjs +2 -2
- package/dist/esm/api/resources/agent/client/Client.d.mts +3 -1
- package/dist/esm/api/resources/agent/client/Client.mjs +3 -1
- package/dist/esm/api/resources/apiKeys/types/ApiKeyPermissions.d.mts +4 -4
- package/dist/esm/api/resources/calendar/types/IanaTimezone.d.mts +5 -3
- package/dist/esm/api/resources/domains/types/Domain.d.mts +11 -4
- package/dist/esm/api/resources/domains/types/RecordType.d.mts +1 -0
- package/dist/esm/api/resources/domains/types/RecordType.mjs +1 -0
- package/dist/esm/api/resources/domains/types/TrackingEnabled.d.mts +4 -3
- package/dist/esm/api/resources/domains/types/TrackingStatus.d.mts +10 -0
- package/dist/esm/api/resources/domains/types/TrackingStatus.mjs +2 -0
- package/dist/esm/api/resources/domains/types/UpdateDomainRequest.d.mts +2 -1
- package/dist/esm/api/resources/domains/types/VerificationRecord.d.mts +1 -1
- package/dist/esm/api/resources/domains/types/index.d.mts +1 -0
- package/dist/esm/api/resources/domains/types/index.mjs +1 -0
- package/dist/esm/api/resources/events/types/EventId.d.mts +3 -1
- package/dist/esm/api/resources/events/types/InboxIds.d.mts +1 -1
- package/dist/esm/api/resources/events/types/MessageReceivedEvent.d.mts +1 -1
- package/dist/esm/api/resources/events/types/PodIds.d.mts +1 -1
- package/dist/esm/api/resources/events/types/ReceivedMessage.d.mts +18 -0
- package/dist/esm/api/resources/events/types/ReceivedMessage.mjs +2 -0
- package/dist/esm/api/resources/events/types/index.d.mts +1 -0
- package/dist/esm/api/resources/events/types/index.mjs +1 -0
- package/dist/esm/api/resources/inboxes/client/Client.d.mts +2 -1
- package/dist/esm/api/resources/inboxes/client/Client.mjs +2 -1
- package/dist/esm/api/resources/inboxes/resources/calendar/client/Client.d.mts +20 -21
- package/dist/esm/api/resources/inboxes/resources/calendar/client/Client.mjs +20 -21
- package/dist/esm/api/resources/inboxes/types/CreateInboxRequest.d.mts +2 -0
- package/dist/esm/api/resources/inboxes/types/Inbox.d.mts +5 -0
- package/dist/esm/api/resources/inboxes/types/PauseAt.d.mts +7 -0
- package/dist/esm/api/resources/inboxes/types/PauseAt.mjs +2 -0
- package/dist/esm/api/resources/inboxes/types/UpdateInboxRequest.d.mts +7 -1
- package/dist/esm/api/resources/inboxes/types/index.d.mts +1 -0
- package/dist/esm/api/resources/inboxes/types/index.mjs +1 -0
- package/dist/esm/api/resources/messages/types/Message.d.mts +1 -0
- package/dist/esm/api/resources/messages/types/MessageAuthenticationDomain.d.mts +5 -0
- package/dist/esm/api/resources/messages/types/MessageAuthenticationDomain.mjs +2 -0
- package/dist/esm/api/resources/messages/types/MessageAuthenticationResults.d.mts +56 -0
- package/dist/esm/api/resources/messages/types/MessageAuthenticationResults.mjs +2 -0
- package/dist/esm/api/resources/messages/types/MessageAuthenticationVerdict.d.mts +16 -0
- package/dist/esm/api/resources/messages/types/MessageAuthenticationVerdict.mjs +16 -0
- package/dist/esm/api/resources/messages/types/MessageCalendarEventId.d.mts +3 -2
- package/dist/esm/api/resources/messages/types/MessageHeaders.d.mts +4 -1
- package/dist/esm/api/resources/messages/types/MessageItem.d.mts +1 -0
- package/dist/esm/api/resources/messages/types/index.d.mts +3 -0
- package/dist/esm/api/resources/messages/types/index.mjs +3 -0
- package/dist/esm/api/resources/metrics/client/Client.d.mts +3 -4
- package/dist/esm/api/resources/metrics/client/Client.mjs +3 -4
- package/dist/esm/api/resources/organizations/client/Client.d.mts +1 -1
- package/dist/esm/api/resources/organizations/client/Client.mjs +1 -1
- package/dist/esm/api/resources/organizations/types/Organization.d.mts +12 -0
- package/dist/esm/api/resources/webhooks/types/CreatePodWebhookRequest.d.mts +4 -0
- package/dist/esm/api/resources/webhooks/types/CreateWebhookEventTypes.d.mts +3 -2
- package/dist/esm/api/resources/webhooks/types/CreateWebhookRequest.d.mts +3 -2
- package/dist/esm/api/resources/webhooks/types/UpdateInboxWebhookRequest.d.mts +6 -4
- package/dist/esm/api/resources/webhooks/types/UpdatePodWebhookRequest.d.mts +2 -1
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookEventTypes.d.mts +2 -2
- package/dist/esm/api/resources/webhooks/types/UpdateWebhookRequest.d.mts +4 -1
- package/dist/esm/api/resources/webhooks/types/Webhook.d.mts +5 -1
- package/dist/esm/serialization/resources/domains/types/Domain.d.mts +3 -0
- package/dist/esm/serialization/resources/domains/types/Domain.mjs +3 -0
- package/dist/esm/serialization/resources/domains/types/RecordType.d.mts +1 -1
- package/dist/esm/serialization/resources/domains/types/RecordType.mjs +1 -1
- package/dist/esm/serialization/resources/domains/types/TrackingStatus.d.mts +8 -0
- package/dist/esm/serialization/resources/domains/types/TrackingStatus.mjs +3 -0
- package/dist/esm/serialization/resources/domains/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/domains/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/events/types/MessageReceivedEvent.d.mts +2 -2
- package/dist/esm/serialization/resources/events/types/MessageReceivedEvent.mjs +2 -2
- package/dist/esm/serialization/resources/events/types/ReceivedMessage.d.mts +11 -0
- package/dist/esm/serialization/resources/events/types/ReceivedMessage.mjs +9 -0
- package/dist/esm/serialization/resources/events/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/events/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/inboxes/types/CreateInboxRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/inboxes/types/CreateInboxRequest.mjs +2 -0
- package/dist/esm/serialization/resources/inboxes/types/Inbox.d.mts +2 -0
- package/dist/esm/serialization/resources/inboxes/types/Inbox.mjs +2 -0
- package/dist/esm/serialization/resources/inboxes/types/PauseAt.d.mts +7 -0
- package/dist/esm/serialization/resources/inboxes/types/PauseAt.mjs +3 -0
- package/dist/esm/serialization/resources/inboxes/types/UpdateInboxRequest.d.mts +2 -0
- package/dist/esm/serialization/resources/inboxes/types/UpdateInboxRequest.mjs +2 -0
- package/dist/esm/serialization/resources/inboxes/types/index.d.mts +1 -0
- package/dist/esm/serialization/resources/inboxes/types/index.mjs +1 -0
- package/dist/esm/serialization/resources/messages/types/Message.d.mts +2 -0
- package/dist/esm/serialization/resources/messages/types/Message.mjs +2 -0
- package/dist/esm/serialization/resources/messages/types/MessageAuthenticationDomain.d.mts +7 -0
- package/dist/esm/serialization/resources/messages/types/MessageAuthenticationDomain.mjs +3 -0
- package/dist/esm/serialization/resources/messages/types/MessageAuthenticationResults.d.mts +17 -0
- package/dist/esm/serialization/resources/messages/types/MessageAuthenticationResults.mjs +13 -0
- package/dist/esm/serialization/resources/messages/types/MessageAuthenticationVerdict.d.mts +7 -0
- package/dist/esm/serialization/resources/messages/types/MessageAuthenticationVerdict.mjs +3 -0
- package/dist/esm/serialization/resources/messages/types/MessageItem.d.mts +2 -0
- package/dist/esm/serialization/resources/messages/types/MessageItem.mjs +2 -0
- package/dist/esm/serialization/resources/messages/types/index.d.mts +3 -0
- package/dist/esm/serialization/resources/messages/types/index.mjs +3 -0
- package/dist/esm/serialization/resources/organizations/types/Organization.d.mts +2 -0
- package/dist/esm/serialization/resources/organizations/types/Organization.mjs +2 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/dist/llms.txt +20 -2
- package/package.json +3 -2
- package/reference.md +29 -28
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type * as AgentMail from "../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* The received message. The body (`text`, `html`, `extracted_text`, and `extracted_html`) is included
|
|
4
|
+
* inline only when it is small enough. Webhooks omit it when the stored body is larger than 64 KiB;
|
|
5
|
+
* WebSocket events also omit it when the serialized event would be larger than 30 KiB. When the body
|
|
6
|
+
* is omitted, `body_url` and `body_expires_at` are set instead.
|
|
7
|
+
*/
|
|
8
|
+
export interface ReceivedMessage extends AgentMail.Message {
|
|
9
|
+
/**
|
|
10
|
+
* Pre-signed URL that downloads the stored body as a JSON object including `text`, `html`,
|
|
11
|
+
* `extracted_text`, and `extracted_html`. Present only when the body is omitted from the event.
|
|
12
|
+
* Valid until `body_expires_at`, one hour after the event was built. The body stays available
|
|
13
|
+
* through the get message endpoint after the URL expires.
|
|
14
|
+
*/
|
|
15
|
+
bodyUrl?: string;
|
|
16
|
+
/** Time at which `body_url` expires. Present only with `body_url`. */
|
|
17
|
+
bodyExpiresAt?: Date;
|
|
18
|
+
}
|
|
@@ -28,6 +28,7 @@ export * from "./MessageSecurityReviewEvent.mjs";
|
|
|
28
28
|
export * from "./MessageSentEvent.mjs";
|
|
29
29
|
export * from "./Open.mjs";
|
|
30
30
|
export * from "./PodIds.mjs";
|
|
31
|
+
export * from "./ReceivedMessage.mjs";
|
|
31
32
|
export * from "./Recipient.mjs";
|
|
32
33
|
export * from "./Reject.mjs";
|
|
33
34
|
export * from "./Send.mjs";
|
|
@@ -28,6 +28,7 @@ export * from "./MessageSecurityReviewEvent.mjs";
|
|
|
28
28
|
export * from "./MessageSentEvent.mjs";
|
|
29
29
|
export * from "./Open.mjs";
|
|
30
30
|
export * from "./PodIds.mjs";
|
|
31
|
+
export * from "./ReceivedMessage.mjs";
|
|
31
32
|
export * from "./Recipient.mjs";
|
|
32
33
|
export * from "./Reject.mjs";
|
|
33
34
|
export * from "./Send.mjs";
|
|
@@ -117,7 +117,8 @@ export declare class InboxesClient {
|
|
|
117
117
|
* ```
|
|
118
118
|
*
|
|
119
119
|
* To pause an inbox, set `status` to `paused`; set it back to `active` to
|
|
120
|
-
* resume.
|
|
120
|
+
* resume. To pause it later, set `pause_at`. See
|
|
121
|
+
* [Pausing an inbox](/inboxes#pausing-an-inbox).
|
|
121
122
|
*
|
|
122
123
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
123
124
|
* @param {AgentMail.inboxes.UpdateInboxRequest} request
|
|
@@ -368,7 +368,8 @@ export class InboxesClient {
|
|
|
368
368
|
* ```
|
|
369
369
|
*
|
|
370
370
|
* To pause an inbox, set `status` to `paused`; set it back to `active` to
|
|
371
|
-
* resume.
|
|
371
|
+
* resume. To pause it later, set `pause_at`. See
|
|
372
|
+
* [Pausing an inbox](/inboxes#pausing-an-inbox).
|
|
372
373
|
*
|
|
373
374
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
374
375
|
* @param {AgentMail.inboxes.UpdateInboxRequest} request
|
|
@@ -17,9 +17,8 @@ export declare class CalendarClient {
|
|
|
17
17
|
* created. Its `etag` (also the `ETag` response header) is the value to send in `If-Match` to
|
|
18
18
|
* make an update conditional.
|
|
19
19
|
*
|
|
20
|
-
* Requires the `calendar_read` permission. Calendar is
|
|
21
|
-
* but not yet in EU production (`api.agentmail.eu`)
|
|
22
|
-
* Labs receive a `403`.
|
|
20
|
+
* Requires the `calendar_read` permission. Calendar is available in US production
|
|
21
|
+
* (`api.agentmail.to`) but not yet in EU production (`api.agentmail.eu`), which returns `403`.
|
|
23
22
|
*
|
|
24
23
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
25
24
|
* @param {AgentMail.inboxes.GetCalendarRequest} request
|
|
@@ -44,8 +43,8 @@ export declare class CalendarClient {
|
|
|
44
43
|
* calendar's current `etag` in `If-Match`: a stale value returns `412`. Without `If-Match` the
|
|
45
44
|
* update applies to the calendar as it is.
|
|
46
45
|
*
|
|
47
|
-
* Calendar is
|
|
48
|
-
*
|
|
46
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
47
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
49
48
|
*
|
|
50
49
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
51
50
|
* @param {AgentMail.inboxes.UpdateCalendarRequestWrapper} request
|
|
@@ -77,8 +76,8 @@ export declare class CalendarClient {
|
|
|
77
76
|
* The list is always read in the region that serves the request, so it can trail a change made
|
|
78
77
|
* moments earlier by a few seconds. Requires the `calendar_event_read` permission.
|
|
79
78
|
*
|
|
80
|
-
* Calendar is
|
|
81
|
-
*
|
|
79
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
80
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
82
81
|
*
|
|
83
82
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
84
83
|
* @param {AgentMail.inboxes.ListCalendarEventsRequest} request
|
|
@@ -115,8 +114,8 @@ export declare class CalendarClient {
|
|
|
115
114
|
* moments earlier by a few seconds. Pass `consistency=primary` to read your own change right
|
|
116
115
|
* away. Requires the `calendar_event_read` permission.
|
|
117
116
|
*
|
|
118
|
-
* Calendar is
|
|
119
|
-
*
|
|
117
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
118
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
120
119
|
*
|
|
121
120
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
122
121
|
* @param {AgentMail.inboxes.GetCalendarAgendaRequest} request
|
|
@@ -158,8 +157,8 @@ export declare class CalendarClient {
|
|
|
158
157
|
* The event's `etag` is the value to send in `If-Match` to make a later update or delete
|
|
159
158
|
* conditional. Requires the `calendar_event_create` permission.
|
|
160
159
|
*
|
|
161
|
-
* Calendar is
|
|
162
|
-
*
|
|
160
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
161
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
163
162
|
*
|
|
164
163
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
165
164
|
* @param {AgentMail.CreateCalendarEventRequest} request
|
|
@@ -220,8 +219,8 @@ export declare class CalendarClient {
|
|
|
220
219
|
* reads back as it ran, even if a later change to the series no longer produces it. Requires
|
|
221
220
|
* the `calendar_event_read` permission.
|
|
222
221
|
*
|
|
223
|
-
* Calendar is
|
|
224
|
-
*
|
|
222
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
223
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
225
224
|
*
|
|
226
225
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
227
226
|
* @param {AgentMail.CalendarEventId} event_id
|
|
@@ -269,8 +268,8 @@ export declare class CalendarClient {
|
|
|
269
268
|
* send limits, charged before the change is saved; an over-limit request returns `429`
|
|
270
269
|
* `rate_limit_exceeded` and changes nothing.
|
|
271
270
|
*
|
|
272
|
-
* Calendar is
|
|
273
|
-
*
|
|
271
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
272
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
274
273
|
*
|
|
275
274
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
276
275
|
* @param {AgentMail.CalendarEventId} event_id
|
|
@@ -327,8 +326,8 @@ export declare class CalendarClient {
|
|
|
327
326
|
* send limits, charged before the delete; an over-limit request returns `429`
|
|
328
327
|
* `rate_limit_exceeded` and deletes nothing.
|
|
329
328
|
*
|
|
330
|
-
* Calendar is
|
|
331
|
-
*
|
|
329
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
330
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
332
331
|
*
|
|
333
332
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
334
333
|
* @param {AgentMail.CalendarEventId} event_id
|
|
@@ -368,8 +367,8 @@ export declare class CalendarClient {
|
|
|
368
367
|
* trail a change made moments earlier by a few seconds; pass `consistency=primary` to read
|
|
369
368
|
* your own change right away. Requires the `calendar_event_read` permission.
|
|
370
369
|
*
|
|
371
|
-
* Calendar is
|
|
372
|
-
*
|
|
370
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
371
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
373
372
|
*
|
|
374
373
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
375
374
|
* @param {string} event_id - UUID of the recurring event.
|
|
@@ -407,8 +406,8 @@ export declare class CalendarClient {
|
|
|
407
406
|
* charged before the response is saved; an over-limit request returns `429`
|
|
408
407
|
* `rate_limit_exceeded` and changes nothing.
|
|
409
408
|
*
|
|
410
|
-
* Calendar is
|
|
411
|
-
*
|
|
409
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
410
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
412
411
|
*
|
|
413
412
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
414
413
|
* @param {AgentMail.CalendarEventId} event_id
|
|
@@ -38,9 +38,8 @@ export class CalendarClient {
|
|
|
38
38
|
* created. Its `etag` (also the `ETag` response header) is the value to send in `If-Match` to
|
|
39
39
|
* make an update conditional.
|
|
40
40
|
*
|
|
41
|
-
* Requires the `calendar_read` permission. Calendar is
|
|
42
|
-
* but not yet in EU production (`api.agentmail.eu`)
|
|
43
|
-
* Labs receive a `403`.
|
|
41
|
+
* Requires the `calendar_read` permission. Calendar is available in US production
|
|
42
|
+
* (`api.agentmail.to`) but not yet in EU production (`api.agentmail.eu`), which returns `403`.
|
|
44
43
|
*
|
|
45
44
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
46
45
|
* @param {AgentMail.inboxes.GetCalendarRequest} request
|
|
@@ -141,8 +140,8 @@ export class CalendarClient {
|
|
|
141
140
|
* calendar's current `etag` in `If-Match`: a stale value returns `412`. Without `If-Match` the
|
|
142
141
|
* update applies to the calendar as it is.
|
|
143
142
|
*
|
|
144
|
-
* Calendar is
|
|
145
|
-
*
|
|
143
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
144
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
146
145
|
*
|
|
147
146
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
148
147
|
* @param {AgentMail.inboxes.UpdateCalendarRequestWrapper} request
|
|
@@ -272,8 +271,8 @@ export class CalendarClient {
|
|
|
272
271
|
* The list is always read in the region that serves the request, so it can trail a change made
|
|
273
272
|
* moments earlier by a few seconds. Requires the `calendar_event_read` permission.
|
|
274
273
|
*
|
|
275
|
-
* Calendar is
|
|
276
|
-
*
|
|
274
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
275
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
277
276
|
*
|
|
278
277
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
279
278
|
* @param {AgentMail.inboxes.ListCalendarEventsRequest} request
|
|
@@ -382,8 +381,8 @@ export class CalendarClient {
|
|
|
382
381
|
* moments earlier by a few seconds. Pass `consistency=primary` to read your own change right
|
|
383
382
|
* away. Requires the `calendar_event_read` permission.
|
|
384
383
|
*
|
|
385
|
-
* Calendar is
|
|
386
|
-
*
|
|
384
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
385
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
387
386
|
*
|
|
388
387
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
389
388
|
* @param {AgentMail.inboxes.GetCalendarAgendaRequest} request
|
|
@@ -516,8 +515,8 @@ export class CalendarClient {
|
|
|
516
515
|
* The event's `etag` is the value to send in `If-Match` to make a later update or delete
|
|
517
516
|
* conditional. Requires the `calendar_event_create` permission.
|
|
518
517
|
*
|
|
519
|
-
* Calendar is
|
|
520
|
-
*
|
|
518
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
519
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
521
520
|
*
|
|
522
521
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
523
522
|
* @param {AgentMail.CreateCalendarEventRequest} request
|
|
@@ -675,8 +674,8 @@ export class CalendarClient {
|
|
|
675
674
|
* reads back as it ran, even if a later change to the series no longer produces it. Requires
|
|
676
675
|
* the `calendar_event_read` permission.
|
|
677
676
|
*
|
|
678
|
-
* Calendar is
|
|
679
|
-
*
|
|
677
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
678
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
680
679
|
*
|
|
681
680
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
682
681
|
* @param {AgentMail.CalendarEventId} event_id
|
|
@@ -808,8 +807,8 @@ export class CalendarClient {
|
|
|
808
807
|
* send limits, charged before the change is saved; an over-limit request returns `429`
|
|
809
808
|
* `rate_limit_exceeded` and changes nothing.
|
|
810
809
|
*
|
|
811
|
-
* Calendar is
|
|
812
|
-
*
|
|
810
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
811
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
813
812
|
*
|
|
814
813
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
815
814
|
* @param {AgentMail.CalendarEventId} event_id
|
|
@@ -988,8 +987,8 @@ export class CalendarClient {
|
|
|
988
987
|
* send limits, charged before the delete; an over-limit request returns `429`
|
|
989
988
|
* `rate_limit_exceeded` and deletes nothing.
|
|
990
989
|
*
|
|
991
|
-
* Calendar is
|
|
992
|
-
*
|
|
990
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
991
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
993
992
|
*
|
|
994
993
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
995
994
|
* @param {AgentMail.CalendarEventId} event_id
|
|
@@ -1138,8 +1137,8 @@ export class CalendarClient {
|
|
|
1138
1137
|
* trail a change made moments earlier by a few seconds; pass `consistency=primary` to read
|
|
1139
1138
|
* your own change right away. Requires the `calendar_event_read` permission.
|
|
1140
1139
|
*
|
|
1141
|
-
* Calendar is
|
|
1142
|
-
*
|
|
1140
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
1141
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
1143
1142
|
*
|
|
1144
1143
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
1145
1144
|
* @param {string} event_id - UUID of the recurring event.
|
|
@@ -1276,8 +1275,8 @@ export class CalendarClient {
|
|
|
1276
1275
|
* charged before the response is saved; an over-limit request returns `429`
|
|
1277
1276
|
* `rate_limit_exceeded` and changes nothing.
|
|
1278
1277
|
*
|
|
1279
|
-
* Calendar is
|
|
1280
|
-
*
|
|
1278
|
+
* Calendar is available in US production (`api.agentmail.to`) but not yet in EU production
|
|
1279
|
+
* (`api.agentmail.eu`), which returns `403`.
|
|
1281
1280
|
*
|
|
1282
1281
|
* @param {AgentMail.inboxes.InboxId} inbox_id
|
|
1283
1282
|
* @param {AgentMail.CalendarEventId} event_id
|
|
@@ -12,6 +12,8 @@ export interface CreateInboxRequest {
|
|
|
12
12
|
clientId?: AgentMail.inboxes.ClientId;
|
|
13
13
|
/** Set `paused` to create the inbox paused. */
|
|
14
14
|
status?: AgentMail.inboxes.InboxStatus;
|
|
15
|
+
/** Schedule the inbox to pause at this time, for example when a fixed term ends. */
|
|
16
|
+
pauseAt?: AgentMail.inboxes.PauseAt;
|
|
15
17
|
/** Custom metadata to attach to the inbox. */
|
|
16
18
|
metadata?: AgentMail.inboxes.Metadata;
|
|
17
19
|
}
|
|
@@ -11,6 +11,11 @@ export interface Inbox {
|
|
|
11
11
|
* receives normally.
|
|
12
12
|
*/
|
|
13
13
|
status?: AgentMail.inboxes.InboxStatus;
|
|
14
|
+
/**
|
|
15
|
+
* When the inbox is scheduled to pause. Omitted when no pause is
|
|
16
|
+
* scheduled, and cleared once the pause happens.
|
|
17
|
+
*/
|
|
18
|
+
pauseAt?: AgentMail.inboxes.PauseAt;
|
|
14
19
|
/** Custom metadata attached to the inbox. */
|
|
15
20
|
metadata?: AgentMail.inboxes.Metadata;
|
|
16
21
|
/** Time at which inbox was last updated. */
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* When the inbox pauses itself. Within about five minutes after this time,
|
|
3
|
+
* the inbox becomes paused exactly as if `status` had been set to `paused`,
|
|
4
|
+
* and `pause_at` is cleared. Must be in the future; returned in UTC. A
|
|
5
|
+
* manual pause or resume does not change it.
|
|
6
|
+
*/
|
|
7
|
+
export type PauseAt = Date;
|
|
@@ -7,13 +7,19 @@ export interface UpdateInboxRequest {
|
|
|
7
7
|
* resume.
|
|
8
8
|
*/
|
|
9
9
|
status?: AgentMail.inboxes.InboxStatus;
|
|
10
|
+
/**
|
|
11
|
+
* Schedule a pause, or move one already scheduled. Send null to cancel
|
|
12
|
+
* it. Only an organization- or pod-scoped API key can change it; an
|
|
13
|
+
* inbox-scoped key gets `403`.
|
|
14
|
+
*/
|
|
15
|
+
pauseAt?: AgentMail.inboxes.PauseAt | null;
|
|
10
16
|
/**
|
|
11
17
|
* Metadata to merge into the inbox's existing metadata. Keys you include
|
|
12
18
|
* are added or overwritten; keys you omit are left unchanged. To remove a
|
|
13
19
|
* single key, send it with a null value. To clear all metadata, send
|
|
14
20
|
* `metadata` as null. Sending an empty object is rejected; use null to
|
|
15
21
|
* clear. Each update must include at least one of `display_name`,
|
|
16
|
-
* `status`, or `metadata`.
|
|
22
|
+
* `status`, `pause_at`, or `metadata`.
|
|
17
23
|
*/
|
|
18
24
|
metadata?: AgentMail.inboxes.UpdateMetadata | null;
|
|
19
25
|
}
|
|
@@ -10,6 +10,7 @@ export * from "./InboxStatus.mjs";
|
|
|
10
10
|
export * from "./ListInboxesResponse.mjs";
|
|
11
11
|
export * from "./Metadata.mjs";
|
|
12
12
|
export * from "./MetadataValue.mjs";
|
|
13
|
+
export * from "./PauseAt.mjs";
|
|
13
14
|
export * from "./SearchInboxesResponse.mjs";
|
|
14
15
|
export * from "./UpdateInboxRequest.mjs";
|
|
15
16
|
export * from "./UpdateMetadata.mjs";
|
|
@@ -10,6 +10,7 @@ export * from "./InboxStatus.mjs";
|
|
|
10
10
|
export * from "./ListInboxesResponse.mjs";
|
|
11
11
|
export * from "./Metadata.mjs";
|
|
12
12
|
export * from "./MetadataValue.mjs";
|
|
13
|
+
export * from "./PauseAt.mjs";
|
|
13
14
|
export * from "./SearchInboxesResponse.mjs";
|
|
14
15
|
export * from "./UpdateInboxRequest.mjs";
|
|
15
16
|
export * from "./UpdateMetadata.mjs";
|
|
@@ -24,6 +24,7 @@ export interface Message {
|
|
|
24
24
|
calendarEventId?: AgentMail.MessageCalendarEventId;
|
|
25
25
|
references?: AgentMail.MessageReferences;
|
|
26
26
|
headers?: AgentMail.MessageHeaders;
|
|
27
|
+
authenticationResults?: AgentMail.MessageAuthenticationResults;
|
|
27
28
|
agentArmor?: AgentMail.AgentArmorResult;
|
|
28
29
|
size: AgentMail.MessageSize;
|
|
29
30
|
updatedAt: AgentMail.MessageUpdatedAt;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import type * as AgentMail from "../../../index.mjs";
|
|
2
|
+
/**
|
|
3
|
+
* Per-mechanism SPF, DKIM, and DMARC verdicts for a received message, each with the domain it
|
|
4
|
+
* is about, kept only where they speak for the sender's From identity. A verdict that could
|
|
5
|
+
* not be computed is absent, so the field can be `{}`. The field is absent on sent messages
|
|
6
|
+
* and on messages received before 2026-09-09; the `*_domain` and `arc_sealer` keys appear on
|
|
7
|
+
* messages received after they were introduced.
|
|
8
|
+
*
|
|
9
|
+
* The verdicts are the ones Amazon SES computed when the message reached AgentMail, with one
|
|
10
|
+
* exception. Forwarded mail fails DMARC at the receiving hop by construction. When AgentMail
|
|
11
|
+
* delivers a forwarded message as authenticated because a trusted forwarder (such as Google or
|
|
12
|
+
* Microsoft) sealed a valid ARC chain vouching for the original, the field reports the
|
|
13
|
+
* verdicts that forwarder recorded for the original message, and `arc_sealer` names it.
|
|
14
|
+
*
|
|
15
|
+
* - `spf` is about the envelope MAIL FROM (Return-Path) domain, named in `spf_domain`. It is
|
|
16
|
+
* present only when that domain is aligned with the sender's domain (the From mailbox, or
|
|
17
|
+
* the Sender header when From spans domains), meaning the two share an organizational
|
|
18
|
+
* domain: `mail.example.com` is aligned with `example.com`. An unaligned SPF result is
|
|
19
|
+
* withheld whatever its value.
|
|
20
|
+
* - `dkim` is the DKIM verdict, and `dkim_domain` the signing domain (the `d=` tag). On
|
|
21
|
+
* directly received mail the domain is named only when every DKIM signature on the message
|
|
22
|
+
* is from the same domain; a message signed by more than one domain (a sender and its email
|
|
23
|
+
* provider, for instance) keeps the verdict and omits the domain. `dkim_domain` is the
|
|
24
|
+
* signing domain as written, so compare it with the From domain before relying on it.
|
|
25
|
+
* - `dmarc` is the DMARC verdict for the From domain, named in `dmarc_domain`.
|
|
26
|
+
* - `dkim` and `dmarc` are withheld when the From list spans more than one domain or could not
|
|
27
|
+
* be fully parsed.
|
|
28
|
+
* - On forwarded mail each sealed verdict is reported only when the domain the forwarder
|
|
29
|
+
* recorded it for matches the message's current From domain. If the forwarder rewrote From,
|
|
30
|
+
* or vouched for nothing, the field is `{}`.
|
|
31
|
+
*
|
|
32
|
+
* The `unauthenticated` label, not this field, is AgentMail's acceptance decision, and it uses
|
|
33
|
+
* a looser rule, so the two can disagree: a single-From message whose only pass is an
|
|
34
|
+
* unaligned envelope SPF is delivered without the label while this field shows no pass. Use
|
|
35
|
+
* the label to tell whether AgentMail accepted the message as legitimate, and this field to
|
|
36
|
+
* see which domain each mechanism authenticated. Do not reject mail on `dmarc: fail` alone.
|
|
37
|
+
*/
|
|
38
|
+
export interface MessageAuthenticationResults {
|
|
39
|
+
spf?: AgentMail.MessageAuthenticationVerdict;
|
|
40
|
+
dkim?: AgentMail.MessageAuthenticationVerdict;
|
|
41
|
+
dmarc?: AgentMail.MessageAuthenticationVerdict;
|
|
42
|
+
/** Envelope MAIL FROM domain the `spf` verdict is about (`smtp.mailfrom`). */
|
|
43
|
+
spfDomain?: AgentMail.MessageAuthenticationDomain;
|
|
44
|
+
/**
|
|
45
|
+
* Signing domain the `dkim` verdict is about (`header.d`). Present only when `dkim` is
|
|
46
|
+
* `pass` or `fail`.
|
|
47
|
+
*/
|
|
48
|
+
dkimDomain?: AgentMail.MessageAuthenticationDomain;
|
|
49
|
+
/** From domain the `dmarc` verdict is about (`header.from`). */
|
|
50
|
+
dmarcDomain?: AgentMail.MessageAuthenticationDomain;
|
|
51
|
+
/**
|
|
52
|
+
* Domain of the trusted forwarder whose ARC seal the verdicts were taken from, such as
|
|
53
|
+
* `google.com`. Present only on forwarded mail, and only beside at least one verdict.
|
|
54
|
+
*/
|
|
55
|
+
arcSealer?: AgentMail.MessageAuthenticationDomain;
|
|
56
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Result of one email authentication mechanism, in the vocabulary of the
|
|
3
|
+
* `Authentication-Results` header (RFC 8601). `none` means there was nothing to evaluate
|
|
4
|
+
* (Amazon SES calls this GRAY): no SPF record for the envelope MAIL FROM domain, no DKIM
|
|
5
|
+
* signature to check, or no DMARC record for the From domain.
|
|
6
|
+
*/
|
|
7
|
+
export declare const MessageAuthenticationVerdict: {
|
|
8
|
+
readonly Pass: "pass";
|
|
9
|
+
readonly Fail: "fail";
|
|
10
|
+
readonly None: "none";
|
|
11
|
+
readonly Neutral: "neutral";
|
|
12
|
+
readonly Softfail: "softfail";
|
|
13
|
+
readonly Temperror: "temperror";
|
|
14
|
+
readonly Permerror: "permerror";
|
|
15
|
+
};
|
|
16
|
+
export type MessageAuthenticationVerdict = (typeof MessageAuthenticationVerdict)[keyof typeof MessageAuthenticationVerdict];
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
/**
|
|
3
|
+
* Result of one email authentication mechanism, in the vocabulary of the
|
|
4
|
+
* `Authentication-Results` header (RFC 8601). `none` means there was nothing to evaluate
|
|
5
|
+
* (Amazon SES calls this GRAY): no SPF record for the envelope MAIL FROM domain, no DKIM
|
|
6
|
+
* signature to check, or no DMARC record for the From domain.
|
|
7
|
+
*/
|
|
8
|
+
export const MessageAuthenticationVerdict = {
|
|
9
|
+
Pass: "pass",
|
|
10
|
+
Fail: "fail",
|
|
11
|
+
None: "none",
|
|
12
|
+
Neutral: "neutral",
|
|
13
|
+
Softfail: "softfail",
|
|
14
|
+
Temperror: "temperror",
|
|
15
|
+
Permerror: "permerror",
|
|
16
|
+
};
|
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
* The calendar event this email's invitation was applied to: set when the email's calendar
|
|
3
3
|
* invitation, update, cancellation or attendee reply changed the inbox's calendar, a few seconds
|
|
4
4
|
* after the email arrives. For an email about one date of a recurring event, it is that date's
|
|
5
|
-
* event ID. Absent on other emails, and on invitations that were not imported.
|
|
6
|
-
*
|
|
5
|
+
* event ID. Absent on other emails, and on invitations that were not imported. The
|
|
6
|
+
* `message.received` event for an email with a calendar attachment waits until this is set, at
|
|
7
|
+
* most 20 seconds, so it usually arrives with it. Calendar is available in US production.
|
|
7
8
|
*/
|
|
8
9
|
export type MessageCalendarEventId = string;
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Headers in message.
|
|
2
|
+
* Headers in message. `Authentication-Results` is never included, on received or sent
|
|
3
|
+
* messages: the header is unsigned, so a sender can plant a forged copy. Read
|
|
4
|
+
* `authentication_results` for the verdicts instead. Get Raw Message still returns every copy
|
|
5
|
+
* of the header.
|
|
3
6
|
*/
|
|
4
7
|
export type MessageHeaders = Record<string, string>;
|
|
@@ -16,6 +16,7 @@ export interface MessageItem {
|
|
|
16
16
|
calendarEventId?: AgentMail.MessageCalendarEventId;
|
|
17
17
|
references?: AgentMail.MessageReferences;
|
|
18
18
|
headers?: AgentMail.MessageHeaders;
|
|
19
|
+
authenticationResults?: AgentMail.MessageAuthenticationResults;
|
|
19
20
|
agentArmor?: AgentMail.AgentArmorResult;
|
|
20
21
|
size: AgentMail.MessageSize;
|
|
21
22
|
updatedAt: AgentMail.MessageUpdatedAt;
|
|
@@ -8,6 +8,9 @@ export * from "./BatchUpdateMessagesResponse.mjs";
|
|
|
8
8
|
export * from "./ListMessagesResponse.mjs";
|
|
9
9
|
export * from "./Message.mjs";
|
|
10
10
|
export * from "./MessageAttachments.mjs";
|
|
11
|
+
export * from "./MessageAuthenticationDomain.mjs";
|
|
12
|
+
export * from "./MessageAuthenticationResults.mjs";
|
|
13
|
+
export * from "./MessageAuthenticationVerdict.mjs";
|
|
11
14
|
export * from "./MessageBcc.mjs";
|
|
12
15
|
export * from "./MessageCalendarEventId.mjs";
|
|
13
16
|
export * from "./MessageCc.mjs";
|
|
@@ -8,6 +8,9 @@ export * from "./BatchUpdateMessagesResponse.mjs";
|
|
|
8
8
|
export * from "./ListMessagesResponse.mjs";
|
|
9
9
|
export * from "./Message.mjs";
|
|
10
10
|
export * from "./MessageAttachments.mjs";
|
|
11
|
+
export * from "./MessageAuthenticationDomain.mjs";
|
|
12
|
+
export * from "./MessageAuthenticationResults.mjs";
|
|
13
|
+
export * from "./MessageAuthenticationVerdict.mjs";
|
|
11
14
|
export * from "./MessageBcc.mjs";
|
|
12
15
|
export * from "./MessageCalendarEventId.mjs";
|
|
13
16
|
export * from "./MessageCc.mjs";
|
|
@@ -54,10 +54,9 @@ export declare class MetricsClient {
|
|
|
54
54
|
* `period` grid point, the bounced (or complained) messages over the
|
|
55
55
|
* preceding `window` divided by the messages sent over the same window,
|
|
56
56
|
* with the send count alongside so you can see the volume behind
|
|
57
|
-
* it.
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
* window. Defaults to the rolling 24-hour rate sampled hourly over the
|
|
57
|
+
* it. AgentMail weighs bounce and complaint signals when deciding
|
|
58
|
+
* whether to suspend an account's sending, so keep both rates low.
|
|
59
|
+
* Defaults to the rolling 24-hour rate sampled hourly over the
|
|
61
60
|
* last day; `start` must be within the last 90 days, `window` must be a
|
|
62
61
|
* whole multiple of `period`, and the range plus window divided by
|
|
63
62
|
* `period` must not exceed 1000 buckets.
|
|
@@ -203,10 +203,9 @@ export class MetricsClient {
|
|
|
203
203
|
* `period` grid point, the bounced (or complained) messages over the
|
|
204
204
|
* preceding `window` divided by the messages sent over the same window,
|
|
205
205
|
* with the send count alongside so you can see the volume behind
|
|
206
|
-
* it.
|
|
207
|
-
*
|
|
208
|
-
*
|
|
209
|
-
* window. Defaults to the rolling 24-hour rate sampled hourly over the
|
|
206
|
+
* it. AgentMail weighs bounce and complaint signals when deciding
|
|
207
|
+
* whether to suspend an account's sending, so keep both rates low.
|
|
208
|
+
* Defaults to the rolling 24-hour rate sampled hourly over the
|
|
210
209
|
* last day; `start` must be within the last 90 days, `window` must be a
|
|
211
210
|
* whole multiple of `period`, and the range plus window divided by
|
|
212
211
|
* `period` must not exceed 1000 buckets.
|
|
@@ -26,7 +26,7 @@ export declare class OrganizationsClient {
|
|
|
26
26
|
get(requestOptions?: OrganizationsClient.RequestOptions): core.HttpResponsePromise<AgentMail.Organization>;
|
|
27
27
|
private __get;
|
|
28
28
|
/**
|
|
29
|
-
* Returns whether the organization is in
|
|
29
|
+
* Returns whether the organization is in AgentMail Labs, which turns on features that are still in preview, such as [Agent Armor](https://docs.agentmail.to/agent-armor). Requires an organization-scoped API key.
|
|
30
30
|
*
|
|
31
31
|
* **CLI:**
|
|
32
32
|
* ```bash
|
|
@@ -76,7 +76,7 @@ export class OrganizationsClient {
|
|
|
76
76
|
});
|
|
77
77
|
}
|
|
78
78
|
/**
|
|
79
|
-
* Returns whether the organization is in
|
|
79
|
+
* Returns whether the organization is in AgentMail Labs, which turns on features that are still in preview, such as [Agent Armor](https://docs.agentmail.to/agent-armor). Requires an organization-scoped API key.
|
|
80
80
|
*
|
|
81
81
|
* **CLI:**
|
|
82
82
|
* ```bash
|
|
@@ -22,6 +22,18 @@ export interface Organization {
|
|
|
22
22
|
authenticationId?: string;
|
|
23
23
|
/** Authentication provider type. */
|
|
24
24
|
authenticationType?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Time at which the organization was suspended. Absent when it is not suspended. A suspended
|
|
27
|
+
* organization cannot send, but it still receives mail, its webhooks and WebSocket events still
|
|
28
|
+
* fire, and API reads keep working. See [account_suspended](https://docs.agentmail.to/errors#account_suspended).
|
|
29
|
+
*/
|
|
30
|
+
suspendedAt?: Date;
|
|
31
|
+
/**
|
|
32
|
+
* Why the organization is suspended, in a short machine-readable form such as `message.bounced`
|
|
33
|
+
* or `message.complained`. Absent when it is not suspended. Email support@agentmail.cc to resolve
|
|
34
|
+
* a suspension.
|
|
35
|
+
*/
|
|
36
|
+
suspendedReason?: string;
|
|
25
37
|
/** Time at which organization was last updated. */
|
|
26
38
|
updatedAt: Date;
|
|
27
39
|
/** Time at which organization was created. */
|
|
@@ -5,5 +5,9 @@ import type * as AgentMail from "../../../index.mjs";
|
|
|
5
5
|
* receive events for the whole pod.
|
|
6
6
|
*/
|
|
7
7
|
export interface CreatePodWebhookRequest extends AgentMail.webhooks.CreateInboxWebhookRequest {
|
|
8
|
+
/**
|
|
9
|
+
* Inboxes for which to send events. A webhook can list at most 10 inboxes and pods combined;
|
|
10
|
+
* more returns `403` with `limit_exceeded`.
|
|
11
|
+
*/
|
|
8
12
|
inboxIds?: AgentMail.InboxIds;
|
|
9
13
|
}
|