Email Providers: Connect Your Email Service

​

Outbound Email Dispatch Pipeline

​

The IEmailMarketingProvider Contract

export interface IEmailMarketingProvider {
  readonly providerType: EmailProviderType;
  
  // Validates API credentials and checks account status
  validate(credentials?: ProviderCredentials): Promise<boolean>;
  
  // Discovers verified sender domains and email identities
  listSenderIdentities(credentials?: ProviderCredentials): Promise<DiscoveredSenderIdentity[]>;
  
  // Checks SPF, DKIM, and MX DNS verification status
  verifySenderIdentity(identity: string, credentials?: ProviderCredentials): Promise<SenderIdentityVerificationResult>;
  
  // Transmits an HTML or plain-text email with tracking headers
  sendEmail(options: SendEmailOptions, credentials?: ProviderCredentials): Promise<SendEmailResult>;
  
  // Parses delivery, bounce, open, click, and complaint webhooks
  parseDeliveryWebhook(headers: Record<string, any>, body: any): EmailWebhookEvent[];
  
  // Parses inbound customer email replies for the Team Inbox
  parseInboundWebhook?(headers: Record<string, any>, body: any): InboundEmailPayload | null;
}

​

Supported Email Provider Packages

​

Domain Authentication & DNS Hygiene

1. SPF (Sender Policy Framework): A TXT record identifying authorized IP addresses and mail servers allowed to send mail on behalf of your domain.
2. DKIM (DomainKeys Identified Mail): CNAME or TXT records containing public cryptographic keys used to verify that message bodies were not altered in transit.
3. DMARC (Domain-based Message Authentication): A policy TXT record at _dmarc.yourdomain.com instructing receiving mail transfer agents (such as Gmail and Yahoo) on how to handle failed SPF or DKIM checks.

​

Setting Up an Email Provider

1. In the BrokerOS dashboard, navigate to Dashboard -> Marketing -> Email -> Settings -> Provider Integrations.
2. Click Add Email Provider and choose your desired service.
3. Enter your API credentials (API key, AWS IAM keys, or OAuth credentials).
4. Enter your corporate sending domain (e.g., updates.skylinerealty.com).
5. Configure your DNS records using the generated SPF, DKIM, and DMARC instructions.
6. Click Verify DNS: Once DNS records propagate, BrokerOS marks the identity as verified and enables it for campaigns.