@ozaiya/openclaw-channel 0.10.37 → 0.10.38

package/dist/src/botEmail.d.ts

@@ -0,0 +1,85 @@
+import type { ChannelAgentTool } from "openclaw/plugin-sdk";
+import type { ResolvedOzaiyaAccount } from "./types.js";
+export interface MailServer {
+    host: string;
+    port: number;
+    secure: boolean;
+}
+/** One mailbox as the server delivers it (channels.ozaiya.addons.email.accounts[]). */
+export interface MailboxConfig {
+    id: string;
+    email: string;
+    label?: string;
+    senderName?: string;
+    user?: string;
+    imap: MailServer;
+    smtp: MailServer;
+    receiveOnly?: boolean;
+    /** `{"password": "…"}` sealed to the bot's public key (ephemeral key + nonce + box, base64). */
+    sealed: string;
+}
+export interface EmailAddonConfig {
+    accounts?: MailboxConfig[];
+    /** A reply to someone who wrote to the mailbox goes out without a card (writing to anyone new always asks). */
+    replyWithoutAsking?: boolean;
+    /** The owner's direct chat with the bot: approval cards and new-mail notices go there. */
+    ownerGroupId?: string;
+}
+/** The add-on's config when the bot has at least one mailbox. */
+export declare function emailAddonOf(account: ResolvedOzaiyaAccount): EmailAddonConfig | null;
+/** "Your own email address…" for the agent's system prompt, or null without a mailbox. */
+export declare function emailIdentityLine(addons: Record<string, Record<string, unknown>> | undefined): string | null;
+export declare function parseMailServer(value: unknown): MailServer | undefined;
+/** Why a mail server connection or login failed, in terms the owner can act on. */
+export type MailFailureReason = "auth" | "blocked" | "timeout" | "notFound" | "refused" | "tls" | "other";
+export interface MailFailure {
+    stage: "imap" | "smtp";
+    reason: MailFailureReason;
+    /** host:port */
+    server: string;
+    error: string;
+}
+/**
+ * Sort an imapflow / nodemailer failure. "blocked" is a connection cut off before TLS was set up —
+ * what a VPN or proxy node that drops mail ports looks like (Clash in global mode, for one).
+ */
+export declare function classifyMailError(e: unknown): MailFailureReason;
+export declare function describeMailFailure(failure: MailFailure): string;
+/**
+ * The `email-check` gateway RPC: sign in to a mailbox the owner is adding — its password sealed to
+ * the bot's key — from this gateway's network, before the app saves it. A failure says which server
+ * and why; when only sending failed it can still be kept for reading (`canReceiveOnly`).
+ */
+export declare function checkNewMailbox(input: Record<string, unknown>, botPrivateKey: Uint8Array): Promise<Record<string, unknown>>;
+export interface BotEmailToolDeps {
+    /** True when the turn calling the tool is the owner's own chat with the bot (and nothing else is running). */
+    inOwnerChat: () => boolean;
+    /** Show an approval card in the owner's chat and wait for the answer (false on reject or no answer). */
+    askOwner: (label: string, params: Record<string, string>) => Promise<boolean>;
+}
+/** The `email` tool for a bot with the add-on: its own mailbox(es). */
+export declare function createBotEmailTool(account: ResolvedOzaiyaAccount, config: EmailAddonConfig, deps: BotEmailToolDeps): ChannelAgentTool;
+export interface NewMail {
+    uid: number;
+    from: string;
+    subject: string;
+    when: string;
+}
+export interface MailWatchDeps {
+    /** Where each mailbox remembers what it has already announced. */
+    stateDir: string;
+    onNewMail: (mailbox: {
+        id: string;
+        email: string;
+    }, mails: NewMail[]) => Promise<void>;
+    log: {
+        info: (msg: string) => void;
+        warn: (msg: string) => void;
+    };
+}
+/** What the agent is told when new mail reaches its mailbox (the turn runs in the owner's chat). */
+export declare function newMailNotice(mailbox: {
+    email: string;
+}, mails: NewMail[], replyWithoutAsking: boolean): string;
+/** Watch every mailbox of a bot with the add-on; the returned function stops it all. */
+export declare function watchMailboxes(account: ResolvedOzaiyaAccount, deps: MailWatchDeps): () => void;