Remy Reference/Agent SDK/Email/EmailQuota

EmailQuota

Type

Your app's sending allowance for a window: the unit, limit, used, remaining, and reset time.

What email.quota returns: your app's sending allowance for the current window. limit and remaining are null when sending is unlimited, so check for null before comparing a recipient count against them. Read remaining before a large send and split the list rather than hitting the cap partway through.

EmailQuota.ts

interface EmailQuota {
  unit: string
  window: 'day' | 'month' | 'total'
  limit: number | null
  used: number
  remaining: number | null
  resetsAt: string | null
}

Fields

unit

string

What the numbers count, e.g. recipients.

window

'day' | 'month' | 'total'

The period the allowance covers.

limit

number | null

The cap for the window. Null means unlimited.

used

number

How much of the window has been consumed.

remaining

number | null

What is left. Null when limit is null.

resetsAt

string | null

When used resets. Null when limit is null.