cf-imap/dist/types/emails.d.ts

IMAP (v4) client for the Cloudflare Workers platform.

/**
 * If the 'peek' boolean is true, fetched emails won't get the '\Seen' flag set. On by default.
 */
export type FetchEmailsProps = {
    limit: [number, number];
    folder: string;
    fetchBody: boolean;
    byteLimit?: number;
    peek?: boolean;
};
export type Email = {
    from: string;
    to: string;
    subject: string;
    messageID: string;
    contentType: string;
    date: Date;
    raw: string;
    body: string;
};
export type SearchEmailsProps = {
    all?: boolean;
    answered?: boolean;
    bcc?: string;
    before?: Date;
    body?: string;
    cc?: string;
    deleted?: boolean;
    draft?: boolean;
    flagged?: boolean;
    from?: string;
    header?: {
        key: string;
        value: string;
    };
    keyword?: string;
    unkeyword?: string;
    largerThan?: number;
    new?: boolean;
    not?: string;
    old?: boolean;
    on?: Date;
    or?: string[];
    recent?: boolean;
    seen?: boolean;
    sentBefore?: Date;
    sentOn?: Date;
    sentSince?: Date;
    since?: Date;
    smallerThan?: number;
    subject?: string;
    text?: string;
    to?: string;
    uid?: string;
};