# @types/addressparser

> TypeScript definitions for addressparser

Latest version **1.0.3** (published 2023-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/addressparser
pnpm add @types/addressparser
yarn add @types/addressparser
bun add @types/addressparser
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2023-11-06 |
| First published | 2020-08-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51431 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/addressparser
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/addressparser
- npm.io page: https://npm.io/package/@types/addressparser

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 1.0.3 (latest) — 2023-11-06
- 1.0.1 (ts3.6) — 2021-07-07
- 1.0.0 (ts3.1) — 2020-08-28
- 1.0.2 — 2023-10-17

## README

# Installation
> `npm install --save @types/addressparser`

# Summary
This package contains type definitions for addressparser (https://github.com/nodemailer/addressparser).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/addressparser.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/addressparser/index.d.ts)
````ts
/// <reference types="node" />

/**
 * Parses structured e-mail addresses from an address field
 *
 * Example:
 *
 *    'Name <address@domain>'
 *
 * will be converted to
 *
 *     [{name: 'Name', address: 'address@domain'}]
 *
 * @param str Address field
 */
declare function addressparser(str: string): addressparser.EmailAddress[];

declare namespace addressparser {
    /**
     * Address details.
     */
    interface EmailAddress {
        /**
         * The email address.
         */
        address: string;
        /**
         * The name part of the email/group.
         */
        name: string;
        /**
         * An array of grouped addresses.
         */
        group?: EmailAddress[] | undefined;
    }
}

export = addressparser;

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:04 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Anton Panov](https://github.com/risedphantom).

---
_Source: https://npm.io/package/@types/addressparser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._