groundmail 0.19.0 → 0.21.0

package/dist/authjs.d.ts

@@ -1,4 +1,4 @@
-import { G as Groundmail } from './client-H0RF4KEK.js';
+import { G as Groundmail } from './client-DmLWvBuY.js';
 
 /** Subset of Auth.js theme used for the default magic-link email. */
 type AuthjsTheme = {

package/dist/better-auth.d.ts

@@ -1,4 +1,4 @@
-import { S as SendEmailResult, G as Groundmail } from './client-H0RF4KEK.js';
+import { S as SendEmailResult, G as Groundmail } from './client-DmLWvBuY.js';
 
 type BetterAuthEmailUser = {
     email: string;

package/dist/clerk.d.ts

@@ -1,4 +1,4 @@
-import { G as Groundmail, S as SendEmailResult } from './client-H0RF4KEK.js';
+import { G as Groundmail, S as SendEmailResult } from './client-DmLWvBuY.js';
 
 /**
  * Subset of Clerk `email.created` webhook `data` used for delivery.

package/dist/{client-H0RF4KEK.d.ts → client-DmLWvBuY.d.ts}

@@ -198,7 +198,10 @@ type ReceivedEmail = {
     to: string[];
     cc: string[];
     subject: string;
-    spam_status: string | null;
+    /** Content scanning verdict; null when the message was not scanned. */
+    spam_status: 'clean' | 'suspicious' | 'spam' | null;
+    /** Content scanning score (most clean mail is under 5); null when not scanned. */
+    spam_score: number | null;
     bounced: boolean;
     received_with_ssl: boolean | null;
     message_id: string | null;
@@ -362,7 +365,7 @@ type CreateSmtpCredentialParams = {
 type CreateSmtpCredentialResult = SmtpCredential & {
     password: string;
 };
-type WebhookEventType = 'email.received' | 'email.sent' | 'email.delivered' | 'email.delivery_delayed' | 'email.bounced' | 'email.complained' | 'email.opened' | 'email.clicked' | 'email.failed' | 'email.suppressed' | 'email.scheduled' | 'contact.unsubscribed' | 'automation.started' | 'automation.step_completed' | 'automation.completed' | 'automation.failed';
+type WebhookEventType = 'email.received' | 'email.sent' | 'email.delivered' | 'email.delivery_delayed' | 'email.held' | 'email.bounced' | 'email.complained' | 'email.opened' | 'email.clicked' | 'email.failed' | 'email.suppressed' | 'email.scheduled' | 'contact.unsubscribed' | 'automation.started' | 'automation.step_completed' | 'automation.completed' | 'automation.failed';
 /** Outbound `email.*` webhook payload (everything except `email.received`). */
 type EmailWebhookEventPayload = {
     type: Exclude<EmailWebhookEventType, 'email.received'>;
@@ -380,6 +383,10 @@ type EmailWebhookEventPayload = {
         test?: true;
         /** The tenant's external id, when the email was sent as a tenant. */
         tenant?: string;
+        /** On `email.held`: why the email was held before sending. */
+        held_reason?: string;
+        /** On `email.held` when content scanning held it: the score. */
+        spam_score?: number;
     };
 };
 /** `contact.unsubscribed` webhook payload (`scope` distinguishes global vs category opt-out). */
@@ -430,7 +437,7 @@ type DailyRampLimitErrorDetails = {
     resets_at: string;
 };
 /** Event types accepted by `POST /emails/test`. */
-type EmailWebhookEventType = 'email.received' | 'email.sent' | 'email.delivered' | 'email.delivery_delayed' | 'email.bounced' | 'email.complained' | 'email.opened' | 'email.clicked' | 'email.failed' | 'email.suppressed' | 'email.scheduled';
+type EmailWebhookEventType = 'email.received' | 'email.sent' | 'email.delivered' | 'email.delivery_delayed' | 'email.held' | 'email.bounced' | 'email.complained' | 'email.opened' | 'email.clicked' | 'email.failed' | 'email.suppressed' | 'email.scheduled';
 type TestEmailWebhookParams = {
     event: EmailWebhookEventType;
     email_id?: string;
@@ -524,6 +531,8 @@ type Automation = {
     status: AutomationStatus;
     trigger: AutomationTrigger;
     steps: AutomationStep[];
+    /** Folder the automation is filed in on the dashboard, or null. */
+    folder: string | null;
     created_at: string;
     updated_at: string;
 };
@@ -531,11 +540,15 @@ type CreateAutomationParams = {
     name: string;
     trigger: AutomationTrigger;
     steps: AutomationStep[];
+    /** File it in this folder, created when it does not exist. */
+    folder?: string;
 };
 type UpdateAutomationParams = {
     name?: string;
     trigger?: AutomationTrigger;
     steps?: AutomationStep[];
+    /** Move it to this folder (created when missing); `null` or `''` takes it out of any folder. */
+    folder?: string | null;
 };
 type AutomationResult = {
     automation: Automation;
@@ -663,6 +676,8 @@ type Template = {
     variables: string[] | null;
     unsubscribe_enabled: boolean;
     category: 'transactional' | 'product' | 'newsletter' | string;
+    /** Folder the template is filed in on the dashboard, or null. */
+    folder: string | null;
     published_version_id: string | null;
     published_at: string | null;
     created_at: string;
@@ -716,6 +731,8 @@ type CreateTemplateParams = {
     variables?: string[];
     unsubscribe_enabled?: boolean;
     category?: 'transactional' | 'product';
+    /** File it in this folder, created when it does not exist. */
+    folder?: string;
 };
 type TemplateStarter = {
     alias: string;
@@ -741,6 +758,8 @@ type UpdateTemplateParams = {
     variables?: string[] | null;
     unsubscribe_enabled?: boolean;
     category?: 'transactional' | 'product' | null;
+    /** Move it to this folder (created when missing); `null` or `''` takes it out of any folder. */
+    folder?: string | null;
 };
 type GroundmailOptions = {
     baseUrl?: string;
@@ -796,6 +815,10 @@ type Domain = {
     inbound_enabled: boolean;
     inbound_status: 'disabled' | 'pending' | 'active' | 'error' | string;
     inbound_error: string | null;
+    /** Received mail at or above this score is `spam`; null uses the default (10). */
+    inbound_spam_threshold?: number | null;
+    /** `flag` keeps spam with `spam_status: 'spam'`; `drop` discards it. */
+    inbound_spam_action?: 'flag' | 'drop';
     /** The tenant that owns this domain (external id). Absent for an account-wide domain. */
     tenant?: string | null;
 };
@@ -883,6 +906,10 @@ type UpdateDomainParams = {
     tlsMode?: DomainTlsMode;
     inbound_enabled?: boolean;
     inboundEnabled?: boolean;
+    /** Spam threshold for received mail (1–100); null resets to the default. */
+    inbound_spam_threshold?: number | null;
+    /** What to do with received mail at or above the threshold. */
+    inbound_spam_action?: 'flag' | 'drop';
 };
 type DnsProviderName = 'cloudflare' | 'godaddy' | 'vercel';
 type RemoteApplyDnsCredentials = {

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { A as ApiErrorBody, D as DnsRecord } from './client-H0RF4KEK.js';
-export { a as ApiErrorCode, b as ApiKey, c as ApiKeyScope, d as ApplyDnsParams, e as ApplyDnsRecordResult, f as ApplyDnsResult, g as Asset, h as Automation, i as AutomationResult, j as AutomationRun, k as AutomationRunResponse, l as AutomationRunStatus, m as AutomationRunStep, n as AutomationRunStepStatus, o as AutomationStatus, p as AutomationStep, q as AutomationTrigger, B as BatchSendEmailResult, r as BounceType, C as CategoryUnsubscribedErrorDetails, s as ConnectTwilioParams, t as ContactWebhookEventPayload, u as CreateApiKeyParams, v as CreateApiKeyResult, w as CreateAutomationParams, x as CreateDomainParams, y as CreateDomainResult, z as CreateMigrationParams, E as CreateSuppressionParams, F as CreateTemplateParams, H as CreateTenantParams, I as CreateWebhookParams, J as DEFAULT_API_BASE_URL, K as DailyRampLimitErrorDetails, L as DeleteTenantResult, M as DeliverabilityBucket, N as DeliverabilityDomainInsight, O as DeliverabilityInsightsResult, P as DeliverabilityMailServerRelay, Q as DeliverabilityWindow, R as DmarcDailyPoint, T as DmarcMonitoring, U as DmarcMonitoringDisabled, V as DmarcReadiness, W as DmarcReadinessVerdict, X as DmarcSource, Y as DmarcSourceStatus, Z as DmarcStatus, _ as DnsProviderName, $ as Domain, a0 as DomainBimiAnalysis, a1 as DomainDetailResult, a2 as DomainDmarcAnalysis, a3 as DomainDnsAnalysis, a4 as DomainStatus, a5 as DomainTlsMode, a6 as DomainTrackingDns, a7 as DomainTrackingStatus, a8 as EmailListItem, a9 as EmailWebhookEventPayload, aa as EmailWebhookEventType, ab as EnableDmarcParams, ac as EnableDmarcResult, ad as EnrollmentSkip, ae as EventRecord, G as Groundmail, af as GroundmailOptions, ag as HeldBackErrorDetails, ah as HeldBackReason, ai as HeldBackRecipient, aj as ListApiKeysParams, ak as ListApiKeysResult, al as ListAutomationRunsParams, am as ListAutomationRunsResult, an as ListAutomationsResult, ao as ListDomainsParams, ap as ListDomainsResult, aq as ListEmailsParams, ar as ListEmailsResult, as as ListReceivedEmailsParams, at as ListReceivedEmailsResult, au as ListSuppressionsParams, av as ListSuppressionsResult, aw as ListTemplatesParams, ax as ListTemplatesResult, ay as ListTenantDomainsResult, az as ListTenantsParams, aA as ListTenantsResult, aB as MailServerSigningStatus, aC as Migration, aD as MigrationDnsChange, aE as MigrationDnsPlan, aF as MigrationDomainItem, aG as MigrationItemStatus, aH as MigrationProvider, aI as MigrationResource, aJ as MigrationSummary, aK as MigrationTemplateItem, aL as MigrationTotals, aM as MigrationWebhookItem, aN as ReceivedEmail, aO as ReceivedEmailAttachment, aP as ReceivedEmailAttachmentMeta, aQ as RemoteApplyDnsCredentials, aR as RunMigrationOptions, aS as SendEmailParams, S as SendEmailResult, aT as SuppressedErrorDetails, aU as Suppression, aV as Template, aW as TemplateFormat, aX as TemplateLintWarning, aY as TemplateStarter, aZ as TemplateStatus, a_ as TemplateVersion, a$ as Tenant, b0 as TenantPauseSource, b1 as TenantRamp, b2 as TenantStats, b3 as TenantStatsResult, b4 as TenantStatus, b5 as TenantStreamPolicy, b6 as TestEmailWebhookParams, b7 as TestEmailWebhookResult, b8 as TriggerEventParams, b9 as TriggerEventResult, ba as TwilioIntegrationResponse, bb as TwilioIntegrationStatus, bc as UpdateAutomationParams, bd as UpdateDomainParams, be as UpdateEmailParams, bf as UpdateTemplateParams, bg as UpdateTenantParams, bh as UpdateWebhookParams, bi as ValidateEmailResult, bj as ValidationReason, bk as ValidationVerdict, bl as VerifyDomainResult, bm as WebhookEndpoint, bn as WebhookEndpointWithSecret, bo as WebhookEventType, bp as mergeMigrations } from './client-H0RF4KEK.js';
+import { A as ApiErrorBody, D as DnsRecord } from './client-DmLWvBuY.js';
+export { a as ApiErrorCode, b as ApiKey, c as ApiKeyScope, d as ApplyDnsParams, e as ApplyDnsRecordResult, f as ApplyDnsResult, g as Asset, h as Automation, i as AutomationResult, j as AutomationRun, k as AutomationRunResponse, l as AutomationRunStatus, m as AutomationRunStep, n as AutomationRunStepStatus, o as AutomationStatus, p as AutomationStep, q as AutomationTrigger, B as BatchSendEmailResult, r as BounceType, C as CategoryUnsubscribedErrorDetails, s as ConnectTwilioParams, t as ContactWebhookEventPayload, u as CreateApiKeyParams, v as CreateApiKeyResult, w as CreateAutomationParams, x as CreateDomainParams, y as CreateDomainResult, z as CreateMigrationParams, E as CreateSuppressionParams, F as CreateTemplateParams, H as CreateTenantParams, I as CreateWebhookParams, J as DEFAULT_API_BASE_URL, K as DailyRampLimitErrorDetails, L as DeleteTenantResult, M as DeliverabilityBucket, N as DeliverabilityDomainInsight, O as DeliverabilityInsightsResult, P as DeliverabilityMailServerRelay, Q as DeliverabilityWindow, R as DmarcDailyPoint, T as DmarcMonitoring, U as DmarcMonitoringDisabled, V as DmarcReadiness, W as DmarcReadinessVerdict, X as DmarcSource, Y as DmarcSourceStatus, Z as DmarcStatus, _ as DnsProviderName, $ as Domain, a0 as DomainBimiAnalysis, a1 as DomainDetailResult, a2 as DomainDmarcAnalysis, a3 as DomainDnsAnalysis, a4 as DomainStatus, a5 as DomainTlsMode, a6 as DomainTrackingDns, a7 as DomainTrackingStatus, a8 as EmailListItem, a9 as EmailWebhookEventPayload, aa as EmailWebhookEventType, ab as EnableDmarcParams, ac as EnableDmarcResult, ad as EnrollmentSkip, ae as EventRecord, G as Groundmail, af as GroundmailOptions, ag as HeldBackErrorDetails, ah as HeldBackReason, ai as HeldBackRecipient, aj as ListApiKeysParams, ak as ListApiKeysResult, al as ListAutomationRunsParams, am as ListAutomationRunsResult, an as ListAutomationsResult, ao as ListDomainsParams, ap as ListDomainsResult, aq as ListEmailsParams, ar as ListEmailsResult, as as ListReceivedEmailsParams, at as ListReceivedEmailsResult, au as ListSuppressionsParams, av as ListSuppressionsResult, aw as ListTemplatesParams, ax as ListTemplatesResult, ay as ListTenantDomainsResult, az as ListTenantsParams, aA as ListTenantsResult, aB as MailServerSigningStatus, aC as Migration, aD as MigrationDnsChange, aE as MigrationDnsPlan, aF as MigrationDomainItem, aG as MigrationItemStatus, aH as MigrationProvider, aI as MigrationResource, aJ as MigrationSummary, aK as MigrationTemplateItem, aL as MigrationTotals, aM as MigrationWebhookItem, aN as ReceivedEmail, aO as ReceivedEmailAttachment, aP as ReceivedEmailAttachmentMeta, aQ as RemoteApplyDnsCredentials, aR as RunMigrationOptions, aS as SendEmailParams, S as SendEmailResult, aT as SuppressedErrorDetails, aU as Suppression, aV as Template, aW as TemplateFormat, aX as TemplateLintWarning, aY as TemplateStarter, aZ as TemplateStatus, a_ as TemplateVersion, a$ as Tenant, b0 as TenantPauseSource, b1 as TenantRamp, b2 as TenantStats, b3 as TenantStatsResult, b4 as TenantStatus, b5 as TenantStreamPolicy, b6 as TestEmailWebhookParams, b7 as TestEmailWebhookResult, b8 as TriggerEventParams, b9 as TriggerEventResult, ba as TwilioIntegrationResponse, bb as TwilioIntegrationStatus, bc as UpdateAutomationParams, bd as UpdateDomainParams, be as UpdateEmailParams, bf as UpdateTemplateParams, bg as UpdateTenantParams, bh as UpdateWebhookParams, bi as ValidateEmailResult, bj as ValidationReason, bk as ValidationVerdict, bl as VerifyDomainResult, bm as WebhookEndpoint, bn as WebhookEndpointWithSecret, bo as WebhookEventType, bp as mergeMigrations } from './client-DmLWvBuY.js';
 
 type GroundmailErrorOptions = {
     code?: string;

package/dist/payload.d.ts

@@ -1,4 +1,4 @@
-import { G as Groundmail } from './client-H0RF4KEK.js';
+import { G as Groundmail } from './client-DmLWvBuY.js';
 
 /**
  * Minimal Payload `SendEmailOptions` / address shapes used by this adapter.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "groundmail",
-  "version": "0.19.0",
+  "version": "0.21.0",
   "description": "Groundmail transactional email API client",
   "license": "MIT",
   "type": "module",
@@ -89,7 +89,7 @@
     "prepublishOnly": "npm run build && npm run build:nodemailer-bridge"
   },
   "dependencies": {
-    "groundmail-nodemailer": "0.15.5"
+    "groundmail-nodemailer": "0.15.7"
   },
   "devDependencies": {
     "@types/nodemailer": "^8.0.1",