Class Received

constructor

• new Received(): Received

  Creates a new empty Received header value.

  Returns Received

• new Received(
      from: string,
      fromTcpInfo: string,
      by: string,
      byTcpInfo: string,
      dateTime: DateTimeOffset,
  ): Received

  Creates a new Received header value from common relay information.

  Parameters

  • from: string

    The source host name.

  • fromTcpInfo: string

    The source host TCP information.

  • by: string

    The receiving host name.

  • byTcpInfo: string

    The receiving host TCP information.

  • dateTime: DateTimeOffset

    The date and time the message was received.

  Returns Received

Readonlyclauses

Clauses

• get Clauses(): ReceivedClause[]

  The collection of received clauses.

  Returns ReceivedClause[]

dateTime

• get dateTime(): DateTimeOffset | null

  The date and time the message was received, if available.

  Returns DateTimeOffset | null

• set dateTime(value: DateTimeOffset | null): void

  Parameters

  • value: DateTimeOffset | null

  Returns void

DateTime

• get DateTime(): DateTimeOffset | null

  The date and time the message was received, if available.

  Returns DateTimeOffset | null

• set DateTime(value: DateTimeOffset | null): void

  Parameters

  • value: DateTimeOffset | null

  Returns void

from

• get from(): string | null

  The source host name, if available.

  Returns string | null

• set from(value: string | null): void

  Parameters

  • value: string | null

  Returns void

From

• get From(): string | null

  The source host name, if available.

  Returns string | null

• set From(value: string | null): void

  Parameters

  • value: string | null

  Returns void

fromTcpInfo

• get fromTcpInfo(): string | null

  The TCP connection information for the source host, if available.

  Returns string | null

• set fromTcpInfo(value: string | null): void

  Parameters

  • value: string | null

  Returns void

FromTcpInfo

• get FromTcpInfo(): string | null

  The TCP connection information for the source host, if available.

  Returns string | null

• set FromTcpInfo(value: string | null): void

  Parameters

  • value: string | null

  Returns void

by

• get by(): string | null

  The receiving host name, if available.

  Returns string | null

• set by(value: string | null): void

  Parameters

  • value: string | null

  Returns void

By

• get By(): string | null

  The receiving host name, if available.

  Returns string | null

• set By(value: string | null): void

  Parameters

  • value: string | null

  Returns void

byTcpInfo

• get byTcpInfo(): string | null

  The TCP connection information for the receiving host, if available.

  Returns string | null

• set byTcpInfo(value: string | null): void

  Parameters

  • value: string | null

  Returns void

ByTcpInfo

• get ByTcpInfo(): string | null

  The TCP connection information for the receiving host, if available.

  Returns string | null

• set ByTcpInfo(value: string | null): void

  Parameters

  • value: string | null

  Returns void

via

• get via(): string | null

  The physical link identifier, if available.

  Returns string | null

• set via(value: string | null): void

  Parameters

  • value: string | null

  Returns void

Via

• get Via(): string | null

  The physical link identifier, if available.

  Returns string | null

• set Via(value: string | null): void

  Parameters

  • value: string | null

  Returns void

with

• get with(): string | null

  The protocol identifier, if available.

  Returns string | null

• set with(value: string | null): void

  Parameters

  • value: string | null

  Returns void

With

• get With(): string | null

  The protocol identifier, if available.

  Returns string | null

• set With(value: string | null): void

  Parameters

  • value: string | null

  Returns void

id

• get id(): string | null

  The message identifier, if available.

  Returns string | null

• set id(value: string | null): void

  Parameters

  • value: string | null

  Returns void

Id

• get Id(): string | null

  The message identifier, if available.

  Returns string | null

• set Id(value: string | null): void

  Parameters

  • value: string | null

  Returns void

for

• get for(): string | null

  The recipient address, if available.

  Returns string | null

• set for(value: string | null): void

  Parameters

  • value: string | null

  Returns void

For

• get For(): string | null

  The recipient address, if available.

  Returns string | null

• set For(value: string | null): void

  Parameters

  • value: string | null

  Returns void

toString

• toString(options?: FormatOptions): string

  Serializes this Received header value.

  Parameters

  • options: FormatOptions = FormatOptions.default

    The formatting options.

  Returns string

  The serialized string.

Staticparse

• parse(
      buffer: Uint8Array,
      startIndex?: number,
      length?: number,
  ): Result<Received>

  Parses a Received header value.

  Parameters

  • buffer: Uint8Array
  • startIndex: number = 0
  • length: number = ...

  Returns Result<Received>

  A Result; { ok: false } with a MimeError on malformed input.

StatictryParse

• tryParse(
      buffer: Uint8Array<ArrayBufferLike> | null | undefined,
      startIndex?: number,
      length?: number,
  ): Result<Received>

  Attempts to parse a Received header value.

  Parameters

  • buffer: Uint8Array<ArrayBufferLike> | null | undefined
  • startIndex: number = 0
  • length: number = ...

  Returns Result<Received>

  A Result; { ok: false } with a MimeError on malformed input or invalid arguments.

StaticfromParsed

• fromParsed(
      clauses: ReceivedClause[],
      dateTime: DateTimeOffset | null,
      dateTimeString: string | null,
  ): Received

  Creates a Received value from parsed clauses and date information.

  Parameters

  • clauses: ReceivedClause[]
  • dateTime: DateTimeOffset | null
  • dateTimeString: string | null

  Returns Received