Class References

A List of references, as per the References or In-Reply-To header fields.

record

Hierarchy

References

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new References(): References

- Defined in GMime-3.0.d.ts:9155
Creates a new #GMimeReferences.

Returns References

Properties

array

array: object[]

the array of message-id references

field

Static name

name: string

Methods

append

append(msgid: string): void

- Defined in GMime-3.0.d.ts:9108
Appends a reference to msgid to the list of references.

Parameters
- msgid: string
  
  a message-id string
Returns void

clear

clear(): void

- Defined in GMime-3.0.d.ts:9112
Clears the #GMimeReferences list.

Returns void

copy

copy(): References

- Defined in GMime-3.0.d.ts:9116
Copies a #GMimeReferences list.

Returns References

free

free(): void

- Defined in GMime-3.0.d.ts:9120
Frees the #GMimeReferences list.

Returns void

getMessageId

getMessageId(index: number): string

- Defined in GMime-3.0.d.ts:9125
Gets the specified Message-Id reference from the #GMimeReferences.

Parameters
- index: number
  
  the index of the message id
Returns string

length

length(): number

- Defined in GMime-3.0.d.ts:9129
Gets the length of the #GMimeReferences list.

Returns number

setMessageId

setMessageId(index: number, msgid: string): void

- Defined in GMime-3.0.d.ts:9135
Sets the specified Message-Id reference from the #GMimeReferences.

Parameters
- index: number
  
  the index of the message id
- msgid: string
  
  the message id
Returns void

Static new

new(): References

- Defined in GMime-3.0.d.ts:9160
Creates a new #GMimeReferences.

Returns References

Static parse

parse(options: ParserOptions, text: string): References

- Defined in GMime-3.0.d.ts:9167
Decodes a list of msg-ids as in the References and/or In-Reply-To headers defined in rfc822.

Parameters
- options: ParserOptions
  
  a #GMimeParserOptions or %NULL
- text: string
  
  string containing a list of msg-ids
Returns References