shipmail 0.6.3 → 0.6.5

package/dist/index.d.cts

@@ -67,9 +67,9 @@ type EmailRecipient = {
     readonly name?: string | null | undefined;
 };
 type EmailRecipientInput = EmailRecipient | string;
-declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
+declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delayed", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
 type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
-declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
+declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delayed", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
 type WebhookDeliveryEventType = (typeof WEBHOOK_DELIVERY_EVENT_TYPES)[number];
 type StatusResponse = {
     readonly status: string;
@@ -1229,12 +1229,16 @@ type InboxFullMessage = Omit<InboxMessage, "object"> & {
     readonly text_body: readonly InboxBodyPart[];
     readonly html_body: readonly InboxBodyPart[];
     readonly attachments: readonly InboxAttachment[];
+    /** What the sender newly wrote, without quoted history or signature. `null` when nothing is left. */
+    readonly reply_text: string | null;
 };
 type InboxMessages = {
     readonly object: "inbox_messages";
     readonly mailbox_id: string;
     readonly address: string;
     readonly data: readonly InboxFullMessage[];
+    /** Messages in Junk that match the other filters, when a folder filter leaves Junk out. Null otherwise. */
+    readonly junk_total: number | null;
     readonly pagination: {
         readonly limit: number;
         readonly total: number;
@@ -1355,10 +1359,13 @@ type InboxMessageAction = {
     readonly address: string;
     readonly message_id: string;
     readonly ok: true;
+    /** Folders and keywords read back after the change. Null when the message could not be read. */
+    readonly folder_ids: readonly string[] | null;
+    readonly keywords: Readonly<Record<string, boolean>> | null;
 };
 type MailboxRuleMatchMode = "all" | "any";
 type MailboxRuleCondition = {
-    readonly type: "from_is" | "from_contains" | "recipient_is" | "plus_tag_is" | "subject_contains";
+    readonly type: "from_is" | "from_contains" | "recipient_is" | "recipient_contains" | "plus_tag_is" | "subject_contains";
     readonly value: string;
 } | {
     readonly type: "has_attachment" | "list_unsubscribe_exists";
@@ -1463,6 +1470,13 @@ type ListInboxMessagesParams = {
     readonly folder_id?: string | undefined;
     readonly folder_role?: "inbox" | "starred" | "sent" | "drafts" | "archive" | "junk" | "trash" | undefined;
     readonly search_text?: string | undefined;
+    /** Matches the From name or address. */
+    readonly from?: string | undefined;
+    /** Matches the To recipients by name or address. Cc and Bcc are not searched. */
+    readonly to?: string | undefined;
+    readonly subject?: string | undefined;
+    /** `true` for messages with an attachment, `false` for messages without one. */
+    readonly has_attachment?: boolean | undefined;
     readonly cursor?: string | undefined;
     readonly after?: string | undefined;
     readonly before?: string | undefined;
@@ -1724,6 +1738,7 @@ type Newsletter = {
     readonly feed_entry_url: string | null;
     readonly styling_mode: NewsletterStylingMode;
     readonly track_engagement: boolean;
+    readonly add_utm_tags: boolean;
     readonly opened_count: number | null;
     readonly clicked_count: number | null;
     readonly preflight_status: NewsletterPreflightStatus;
@@ -1815,6 +1830,7 @@ type CreateNewsletterParams = {
     readonly feed_entry_url?: string | null | undefined;
     readonly styling_mode?: NewsletterStylingMode | undefined;
     readonly track_engagement?: boolean | undefined;
+    readonly add_utm_tags?: boolean | undefined;
 };
 type UpdateNewsletterParams = Partial<CreateNewsletterParams>;
 type NewsletterChangelogMedia = {
@@ -2223,6 +2239,11 @@ type Webhook = {
     readonly description: string | null;
     readonly mailbox_ids: readonly string[] | null;
     readonly domain_ids: readonly string[] | null;
+    readonly has_authorization: boolean;
+    readonly has_standard_webhooks_secret: boolean;
+    readonly include_reply_text: boolean;
+    readonly authenticated_senders_only: boolean;
+    readonly allowed_senders: readonly string[] | null;
     readonly created_at: string;
     readonly updated_at: string;
 };
@@ -2235,6 +2256,16 @@ type CreateWebhookParams = {
     readonly description?: string | undefined;
     readonly mailbox_ids?: readonly string[] | null | undefined;
     readonly domain_ids?: readonly string[] | null | undefined;
+    /** Sent verbatim as the `Authorization` header of every delivery. Write-only. */
+    readonly authorization?: string | null | undefined;
+    /** A `whsec_` secret from the receiving service. Deliveries then carry Standard Webhooks signatures. Write-only. */
+    readonly standard_webhooks_secret?: string | null | undefined;
+    /** Add `reply_text` to `message.received` deliveries. The API key also needs `messages:read`. */
+    readonly include_reply_text?: boolean | undefined;
+    /** Skip `message.received` deliveries whose sender did not pass DMARC. */
+    readonly authenticated_senders_only?: boolean | undefined;
+    /** Deliver `message.received` only from these addresses or exact domains. At most 100. */
+    readonly allowed_senders?: readonly string[] | null | undefined;
 };
 type UpdateWebhookParams = {
     readonly url?: string | undefined;
@@ -2243,6 +2274,16 @@ type UpdateWebhookParams = {
     readonly active?: boolean | undefined;
     readonly mailbox_ids?: readonly string[] | null | undefined;
     readonly domain_ids?: readonly string[] | null | undefined;
+    /** A string replaces the delivery `Authorization` header, `null` removes it. */
+    readonly authorization?: string | null | undefined;
+    /** A string replaces the Standard Webhooks signing secret, `null` removes it. */
+    readonly standard_webhooks_secret?: string | null | undefined;
+    /** Add `reply_text` to `message.received` deliveries. The API key also needs `messages:read`. */
+    readonly include_reply_text?: boolean | undefined;
+    /** Skip `message.received` deliveries whose sender did not pass DMARC. */
+    readonly authenticated_senders_only?: boolean | undefined;
+    /** Replaces the sender list. `null` or `[]` delivers every sender again. */
+    readonly allowed_senders?: readonly string[] | null | undefined;
 };
 type ListWebhooksParams = PaginationParams;
 type RotateSecretResponse = {

package/dist/index.d.ts

@@ -67,9 +67,9 @@ type EmailRecipient = {
     readonly name?: string | null | undefined;
 };
 type EmailRecipientInput = EmailRecipient | string;
-declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
+declare const WEBHOOK_EVENT_TYPES: readonly ["message.received", "message.sent", "message.delayed", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
 type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
-declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
+declare const WEBHOOK_DELIVERY_EVENT_TYPES: readonly ["webhook.test", "message.received", "message.sent", "message.delayed", "message.delivered", "message.bounced", "message.complained", "mailbox.rule_matched", "mailbox.export.completed", "mailbox.export.failed", "domain.verified", "domain.verification_failed", "domain.degraded", "org.reputation_warning", "org.sending_throttled", "org.sending_suspended", "org.reputation_recovered", "reply.overdue", "conversation.needs_action", "calendar.event_starting", "booking.created", "subscriber.added", "newsletter.sent"];
 type WebhookDeliveryEventType = (typeof WEBHOOK_DELIVERY_EVENT_TYPES)[number];
 type StatusResponse = {
     readonly status: string;
@@ -1229,12 +1229,16 @@ type InboxFullMessage = Omit<InboxMessage, "object"> & {
     readonly text_body: readonly InboxBodyPart[];
     readonly html_body: readonly InboxBodyPart[];
     readonly attachments: readonly InboxAttachment[];
+    /** What the sender newly wrote, without quoted history or signature. `null` when nothing is left. */
+    readonly reply_text: string | null;
 };
 type InboxMessages = {
     readonly object: "inbox_messages";
     readonly mailbox_id: string;
     readonly address: string;
     readonly data: readonly InboxFullMessage[];
+    /** Messages in Junk that match the other filters, when a folder filter leaves Junk out. Null otherwise. */
+    readonly junk_total: number | null;
     readonly pagination: {
         readonly limit: number;
         readonly total: number;
@@ -1355,10 +1359,13 @@ type InboxMessageAction = {
     readonly address: string;
     readonly message_id: string;
     readonly ok: true;
+    /** Folders and keywords read back after the change. Null when the message could not be read. */
+    readonly folder_ids: readonly string[] | null;
+    readonly keywords: Readonly<Record<string, boolean>> | null;
 };
 type MailboxRuleMatchMode = "all" | "any";
 type MailboxRuleCondition = {
-    readonly type: "from_is" | "from_contains" | "recipient_is" | "plus_tag_is" | "subject_contains";
+    readonly type: "from_is" | "from_contains" | "recipient_is" | "recipient_contains" | "plus_tag_is" | "subject_contains";
     readonly value: string;
 } | {
     readonly type: "has_attachment" | "list_unsubscribe_exists";
@@ -1463,6 +1470,13 @@ type ListInboxMessagesParams = {
     readonly folder_id?: string | undefined;
     readonly folder_role?: "inbox" | "starred" | "sent" | "drafts" | "archive" | "junk" | "trash" | undefined;
     readonly search_text?: string | undefined;
+    /** Matches the From name or address. */
+    readonly from?: string | undefined;
+    /** Matches the To recipients by name or address. Cc and Bcc are not searched. */
+    readonly to?: string | undefined;
+    readonly subject?: string | undefined;
+    /** `true` for messages with an attachment, `false` for messages without one. */
+    readonly has_attachment?: boolean | undefined;
     readonly cursor?: string | undefined;
     readonly after?: string | undefined;
     readonly before?: string | undefined;
@@ -1724,6 +1738,7 @@ type Newsletter = {
     readonly feed_entry_url: string | null;
     readonly styling_mode: NewsletterStylingMode;
     readonly track_engagement: boolean;
+    readonly add_utm_tags: boolean;
     readonly opened_count: number | null;
     readonly clicked_count: number | null;
     readonly preflight_status: NewsletterPreflightStatus;
@@ -1815,6 +1830,7 @@ type CreateNewsletterParams = {
     readonly feed_entry_url?: string | null | undefined;
     readonly styling_mode?: NewsletterStylingMode | undefined;
     readonly track_engagement?: boolean | undefined;
+    readonly add_utm_tags?: boolean | undefined;
 };
 type UpdateNewsletterParams = Partial<CreateNewsletterParams>;
 type NewsletterChangelogMedia = {
@@ -2223,6 +2239,11 @@ type Webhook = {
     readonly description: string | null;
     readonly mailbox_ids: readonly string[] | null;
     readonly domain_ids: readonly string[] | null;
+    readonly has_authorization: boolean;
+    readonly has_standard_webhooks_secret: boolean;
+    readonly include_reply_text: boolean;
+    readonly authenticated_senders_only: boolean;
+    readonly allowed_senders: readonly string[] | null;
     readonly created_at: string;
     readonly updated_at: string;
 };
@@ -2235,6 +2256,16 @@ type CreateWebhookParams = {
     readonly description?: string | undefined;
     readonly mailbox_ids?: readonly string[] | null | undefined;
     readonly domain_ids?: readonly string[] | null | undefined;
+    /** Sent verbatim as the `Authorization` header of every delivery. Write-only. */
+    readonly authorization?: string | null | undefined;
+    /** A `whsec_` secret from the receiving service. Deliveries then carry Standard Webhooks signatures. Write-only. */
+    readonly standard_webhooks_secret?: string | null | undefined;
+    /** Add `reply_text` to `message.received` deliveries. The API key also needs `messages:read`. */
+    readonly include_reply_text?: boolean | undefined;
+    /** Skip `message.received` deliveries whose sender did not pass DMARC. */
+    readonly authenticated_senders_only?: boolean | undefined;
+    /** Deliver `message.received` only from these addresses or exact domains. At most 100. */
+    readonly allowed_senders?: readonly string[] | null | undefined;
 };
 type UpdateWebhookParams = {
     readonly url?: string | undefined;
@@ -2243,6 +2274,16 @@ type UpdateWebhookParams = {
     readonly active?: boolean | undefined;
     readonly mailbox_ids?: readonly string[] | null | undefined;
     readonly domain_ids?: readonly string[] | null | undefined;
+    /** A string replaces the delivery `Authorization` header, `null` removes it. */
+    readonly authorization?: string | null | undefined;
+    /** A string replaces the Standard Webhooks signing secret, `null` removes it. */
+    readonly standard_webhooks_secret?: string | null | undefined;
+    /** Add `reply_text` to `message.received` deliveries. The API key also needs `messages:read`. */
+    readonly include_reply_text?: boolean | undefined;
+    /** Skip `message.received` deliveries whose sender did not pass DMARC. */
+    readonly authenticated_senders_only?: boolean | undefined;
+    /** Replaces the sender list. `null` or `[]` delivers every sender again. */
+    readonly allowed_senders?: readonly string[] | null | undefined;
 };
 type ListWebhooksParams = PaginationParams;
 type RotateSecretResponse = {

package/dist/index.js

@@ -849,6 +849,10 @@ var Mailboxes = class extends ApiResource {
         folder_id: params?.folder_id,
         folder_role: params?.folder_role,
         search_text: params?.search_text,
+        from: params?.from,
+        to: params?.to,
+        subject: params?.subject,
+        has_attachment: params?.has_attachment,
         cursor: params?.cursor,
         after: params?.after,
         before: params?.before,
@@ -1661,7 +1665,7 @@ var Webhooks = class extends ApiResource {
 };
 
 // src/version.ts
-var VERSION = "0.6.3";
+var VERSION = "0.6.5";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
@@ -1854,6 +1858,7 @@ var CONFERENCING_PROVIDER_IDS = ["zoom", "google_meet"];
 var WEBHOOK_EVENT_TYPES = [
   "message.received",
   "message.sent",
+  "message.delayed",
   "message.delivered",
   "message.bounced",
   "message.complained",