misarmail library
Classes
- AbTestsResource
- AiResource
-
ai— generated. - AnalyticsResource
- AutomationsResource
- BillingResource
- CampaignsResource
- ContactsResource
- CreditRatesResource
-
creditRates— generated. - DedicatedIpsResource
- DeliverabilityResource
-
deliverability— generated. - DmarcResource
-
dmarc— generated. - DomainsResource
- EmailAccountsResource
-
emailAccounts— generated. - EmailResource
- EmailsResource
-
emails— generated. - InboundResource
- KeysResource
- LandingPagesResource
-
landingPages— generated. - MisarMailClient
- MisarMailStreamEvent
- One decoded SSE frame.
- MonetizationResource
-
monetization— generated. - PlanResource
- Live subscription standing for the key's owner.
- RevenueResource
-
revenue— generated. - SandboxResource
- SegmentsResource
-
segments— generated. - StreamingResource
- The two Server-Sent Events endpoints.
- SubscriptionResource
-
subscription— generated. - TeamMembersResource
-
teamMembers— generated. - TemplatesResource
- TrackResource
- UsageResource
- ValidateResource
- WalletResource
-
wallet— generated. - WarmupResource
-
warmup— generated. - WebhooksResource
Constants
- defaultToleranceSeconds → const int
Functions
-
encodeQuery(
Map< String, String?> params) → String - Query-string encoding shared by every generated GET/DELETE method.
-
signWebhook(
String payload, String timestamp, String secret) → String -
Produces the digest MisarMail sends in
X-Misar-Signature. -
streamSse(
String url, String apiKey, {String method = 'GET', Object? body, Client? httpClient}) → Stream< Map< String, dynamic> > - Server-Sent Events client for the MisarMail streaming endpoints.
-
verifyWebhookSignature(
{required String payload, required String signature, required String timestamp, required String secret, int toleranceSeconds = defaultToleranceSeconds}) → bool - Verifies an inbound webhook.
Exceptions / Errors
- MisarMailError
- Raised for any non-2xx response, and for transport failures with status 0.
- MisarMailNetworkError
- MisarMailPlanLimitError
- Thrown when the subscription attached to the API key blocks the call.