@agentmbox/plugin-agentmbox 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,246 @@
+import { Service, IAgentRuntime, Plugin } from '@elizaos/core';
+
+/**
+ * AgentMBox Plugin Types
+ * TypeScript interfaces for AgentMBox email integration
+ */
+interface AgentMBoxConfig {
+    /** API key for AgentMBox (starts with ai_) */
+    apiKey: string;
+    /** Mailbox address (e.g., my-agent@agentmbox.com) */
+    mailbox?: string;
+    /** Base URL for AgentMBox API (default: https://agentmbox.com/api/v1) */
+    baseUrl?: string;
+}
+interface EmailAddress {
+    name?: string;
+    email: string;
+}
+interface Email {
+    id: string;
+    from: EmailAddress[];
+    to: EmailAddress[];
+    cc?: EmailAddress[] | null;
+    subject: string;
+    receivedAt: string;
+    textBody?: string;
+    htmlBody?: string;
+    preview?: string;
+    hasAttachment: boolean;
+    isRead: boolean;
+}
+interface EmailListResponse {
+    mailbox: string;
+    emails: Email[];
+    limit: number;
+    offset: number;
+}
+interface EmailDetailResponse {
+    email: Email;
+}
+interface SendEmailRequest {
+    /** Sender address (must be a mailbox you own) */
+    from: string;
+    /** Recipient(s) - single email or array */
+    to: string | string[];
+    /** Email subject line */
+    subject: string;
+    /** Plain text body */
+    text?: string;
+    /** HTML body */
+    html?: string;
+}
+interface SendEmailResponse {
+    success: boolean;
+}
+interface Mailbox {
+    id: string;
+    address: string;
+    localPart: string;
+    domainName: string;
+    displayName?: string | null;
+    password?: string;
+    createdAt: string;
+}
+interface MailboxListResponse {
+    mailboxes: Mailbox[];
+}
+interface CreateMailboxRequest {
+    localPart: string;
+    domainId?: string;
+    displayName?: string;
+}
+interface CreateMailboxResponse {
+    mailbox: Mailbox;
+}
+interface PaymentStatus {
+    paid: boolean;
+    paidUntil: string | null;
+    solanaAddress: string;
+    usdcPerPeriod: number;
+    periodDays: number;
+    creditedUsdc: number;
+    payments: unknown[];
+}
+interface PaymentCheckResponse {
+    paid: boolean;
+    paidUntil: string;
+    newCredits: number;
+    balanceUsdc: number;
+    creditedUsdc: number;
+}
+interface Domain {
+    id: string;
+    domain: string;
+    verified: boolean;
+}
+interface DomainDNSRecords {
+    verification: {
+        type: string;
+        name: string;
+        value: string;
+    };
+    mx: {
+        type: string;
+        name: string;
+        value: string;
+        priority: number;
+    };
+    spf: {
+        type: string;
+        name: string;
+        value: string;
+    };
+    dkim: {
+        type: string;
+        name: string;
+        value: string;
+    };
+}
+interface DomainResponse {
+    domain: Domain;
+    dnsRecords: DomainDNSRecords;
+}
+interface DomainVerifyResponse {
+    verified: boolean;
+    txtVerified: boolean;
+    mxVerified: boolean;
+    spfVerified: boolean;
+    dkimVerified: boolean;
+}
+interface DomainListResponse {
+    domains: (Domain & {
+        dnsRecords?: DomainDNSRecords;
+    })[];
+}
+interface ApiKey {
+    id: string;
+    name: string;
+    key: string;
+    keyPrefix: string;
+}
+interface ApiKeyResponse {
+    id: string;
+    name: string;
+    key: string;
+    keyPrefix: string;
+}
+interface ApiKeyListResponse {
+    keys: ApiKey[];
+}
+interface AgentMBoxError {
+    error: string;
+}
+type AgentMBoxErrorCode = 400 | 401 | 402 | 403 | 404 | 409 | 502;
+declare function isAgentMBoxError(response: unknown): response is AgentMBoxError;
+
+declare class AgentMBoxService extends Service {
+    private apiKey;
+    private mailbox;
+    private baseUrl;
+    static serviceName: "agentmbox";
+    constructor(runtime?: IAgentRuntime);
+    get serviceName(): string;
+    get capabilityDescription(): string;
+    initialize(runtime: IAgentRuntime): Promise<void>;
+    stop(): Promise<void>;
+    private request;
+    private getMailboxParam;
+    listEmails(limit?: number, offset?: number): Promise<EmailListResponse>;
+    getEmail(emailId: string): Promise<EmailDetailResponse>;
+    sendEmail(request: SendEmailRequest): Promise<SendEmailResponse>;
+    deleteEmail(emailId: string): Promise<{
+        success: boolean;
+    }>;
+    listMailboxes(): Promise<MailboxListResponse>;
+    createMailbox(request: CreateMailboxRequest): Promise<CreateMailboxResponse>;
+    deleteMailbox(mailboxId: string): Promise<{
+        success: boolean;
+    }>;
+    getPaymentStatus(): Promise<PaymentStatus>;
+    checkPayment(): Promise<PaymentCheckResponse>;
+    listDomains(): Promise<DomainListResponse>;
+    addDomain(domain: string): Promise<DomainResponse>;
+    verifyDomain(domainId: string): Promise<DomainVerifyResponse>;
+    deleteDomain(domainId: string): Promise<{
+        success: boolean;
+    }>;
+    createApiKey(name: string): Promise<ApiKeyResponse>;
+    getStatus(): Promise<{
+        paid: boolean;
+        paidUntil: string | null;
+    }>;
+}
+
+/**
+ * AgentMBox Onboarding Service
+ * Handles autonomous account creation and setup for AgentMBox
+ * The agent pays for its own subscription using its Solana wallet
+ */
+
+interface OnboardingStatus {
+    stage: "pending" | "account_created" | "api_key_created" | "awaiting_payment" | "paid" | "mailbox_created" | "complete" | "error";
+    paymentAddress?: string;
+    mailbox?: string;
+    error?: string;
+}
+declare class AgentMBoxOnboardingService extends Service {
+    private apiKey;
+    private mailbox;
+    private baseUrl;
+    private cfg;
+    private status;
+    static serviceName: "agentmbox-onboarding";
+    constructor(runtime?: IAgentRuntime);
+    get serviceName(): string;
+    get capabilityDescription(): string;
+    getApiKey(): string;
+    getMailbox(): string | undefined;
+    private generatePassword;
+    private getAgentWallet;
+    private request;
+    private authenticatedRequest;
+    startOnboarding(runtime: IAgentRuntime): Promise<OnboardingStatus>;
+    private checkExistingSetup;
+    private payForSubscription;
+    stop(): Promise<void>;
+    private createAccount;
+    private createApiKey;
+    private getPaymentStatus;
+    private waitForPayment;
+    private createMailbox;
+    getOrCreateMailbox(): Promise<Mailbox | null>;
+    getStatus(): OnboardingStatus;
+    getPaymentAddress(): Promise<string | null>;
+    isOnboardingComplete(): boolean;
+}
+
+/**
+ * AgentMBox Plugin for ElizaOS
+ * Email integration plugin that enables AI agents to send and receive emails
+ * Includes autonomous self-onboarding using the agent's Solana wallet
+ */
+
+declare const agentMBoxPlugin: Plugin;
+
+export { type AgentMBoxConfig, type AgentMBoxError, type AgentMBoxErrorCode, AgentMBoxOnboardingService, AgentMBoxService, type ApiKey, type ApiKeyListResponse, type ApiKeyResponse, type CreateMailboxRequest, type CreateMailboxResponse, type Domain, type DomainDNSRecords, type DomainListResponse, type DomainResponse, type DomainVerifyResponse, type Email, type EmailAddress, type EmailDetailResponse, type EmailListResponse, type Mailbox, type MailboxListResponse, type PaymentCheckResponse, type PaymentStatus, type SendEmailRequest, type SendEmailResponse, agentMBoxPlugin, agentMBoxPlugin as default, isAgentMBoxError };