Class GroupAddress

Represents a named group of internet addresses.

Hierarchy (View Summary)

InternetAddress
- GroupAddress

Index

Constructors

Properties

members onChanged encoding

Accessors

Methods

clone encode toString equals parse compareTo changed encodeInternationalizedPhrase tryParseInternal

Constructors

constructor

new GroupAddress(
name: string | null | undefined,
members?: Iterable<InternetAddress, any, any>,
): GroupAddress
Creates a new group address.
Parameters
- name: string | null | undefined
  The group display name.
- Optionalmembers: Iterable<InternetAddress, any, any>
  The group members.
Returns GroupAddress
Overrides InternetAddress.constructor
- Defined in src/group-address.ts:32

Properties

`Readonly`members

members: InternetAddressList

The members of the group address.

onChanged

onChanged: (() => void) | null = null

Invoked when the address changes.

encoding

encoding: string | CharsetEncoding = 'utf-8'

The charset used when encoding the display name.

Accessors

name

get name(): string | null
The display name for the address, if available.

Returns string | null
Inherited from SecureMailboxAddress.name
- Defined in src/internet-address.ts:96
set name(value: string | null): void
Parameters
- value: string | null
Returns void
Inherited from SecureMailboxAddress.name
- Defined in src/internet-address.ts:100

Methods

clone

clone(): GroupAddress
Clones this group address.

Returns GroupAddress
Overrides InternetAddress.clone
- Defined in src/group-address.ts:39

encode

encode(options: FormatOptions, firstToken: boolean, state: LineState): string
Encodes this group address.
Parameters
- options: FormatOptions
- firstToken: boolean
- state: LineState
Returns string
Overrides InternetAddress.encode
- Defined in src/group-address.ts:44

toString

toString(options?: FormatOptions, encode?: boolean): string
Serializes this group address.
Parameters
- options: FormatOptions = FormatOptions.default
- encode: boolean = false
Returns string
Overrides InternetAddress.toString
- Defined in src/group-address.ts:77

equals

equals(other: InternetAddress | null | undefined): boolean
Determines whether this group address equals another address.
Parameters
- other: InternetAddress | null | undefined
Returns boolean
Overrides InternetAddress.equals
- Defined in src/group-address.ts:87

`Static`parse

parse(
text: string | Uint8Array<ArrayBufferLike>,
options?: ParserOptions,
): Result<GroupAddress>
Parses a group address.
Parameters
- text: string | Uint8Array<ArrayBufferLike>
- options: ParserOptions = ParserOptions.default
Returns Result<GroupAddress>
A Result; { ok: false } with a MimeError on malformed input.
Overrides InternetAddress.parse
- Defined in src/group-address.ts:96

compareTo

compareTo(other: InternetAddress): number
Compares this address with another address.
Parameters
- other: InternetAddress
Returns number
Inherited from InternetAddress.compareTo
- Defined in src/internet-address.ts:116

`Protected`changed

changed(): void
Returns void
Inherited from InternetAddress.changed
- Defined in src/internet-address.ts:150

`Static`encodeInternationalizedPhrase

encodeInternationalizedPhrase(phrase: string): string
Encodes an internationalized display-name phrase when quoting is required.
Parameters
- phrase: string
Returns string
Inherited from InternetAddress.encodeInternationalizedPhrase
- Defined in src/internet-address.ts:155

`Static`tryParseInternal

tryParseInternal(
    flags: AddressParserFlags,
    options: ParserOptions,
    text: Uint8Array,
    cursor: ParseCursor,
    endIndex: number,
    groupDepth: number,
): Result<InternetAddress>
Attempts to parse an internet address from a byte range.
Parameters
- flags: AddressParserFlags
- options: ParserOptions
- text: Uint8Array
- cursor: ParseCursor
- endIndex: number
- groupDepth: number
Returns Result<InternetAddress>
A Result; { ok: false } with a MimeError on malformed input.
Inherited from InternetAddress.tryParseInternal
- Defined in src/internet-address.ts:187