@visulima/email/dist/utils/parse-address.d.ts

A comprehensive email library with multi-provider support, crypto utilities, and template engines

import type { EmailAddress } from "../types.d.ts";
/**
 * Parses a string representation of an email address into an EmailAddress object.
 * Supports formats: "email@example.com", "Name <email@example.com>", "<email@example.com>".
 * @example Parsing an address with a name
 * ```ts
 * const address = parseAddress("John Doe <john@example.com>");
 * // { name: "John Doe", email: "john@example.com" }
 * ```
 * @example Parsing an address without a name
 * ```ts
 * const address = parseAddress("jane@example.com");
 * // { email: "jane@example.com" }
 * ```
 * @param address The string representation of the address to parse.
 * @returns An EmailAddress object if parsing is successful, or undefined if invalid.
 */
declare const parseAddress: (address: string) => EmailAddress | undefined;
export default parseAddress;