mimekit-ts - v1.0.0
    Preparing search index...

    Class TnefPropertyReader

    A TNEF property reader.

    Index
    constructor
    propertyTag propertyNameId rawValueStreamOffset rawValueLength propertyCount valueCount rowCount attachMethod
    isEmbeddedMessage isMultiValuedProperty isNamedProperty isObjectProperty valueType
    getRawValueReadStream getEmbeddedMessageReader readNextProperty readNextRow readNextValue readRawValue readTextValue readValue readValueAsBoolean readValueAsBytes readValueAsDateTime readValueAsDouble readValueAsFloat readValueAsInt16 readValueAsInt32 readValueAsInt64 readValueAsGuid readValueAsString readValueAsUri load
    propertyTag: TnefPropertyTag = TnefPropertyTag.Null

    Gets the current property tag.

    propertyNameId: TnefNameId = ...

    Gets the current property name identifier.

    rawValueStreamOffset: number = 0

    Gets the raw value stream offset.

    rawValueLength: number = 0

    Gets the length of the raw value.

    propertyCount: number = 0

    Gets the property count.

    valueCount: number = 0

    Gets the value count.

    rowCount: number = 0

    Gets the row count.

    attachMethod: number = TnefAttachMethod.None

    Gets or sets the current attachment method.

    • Read the next property.

      Returns boolean

      true if there is another property available to read; otherwise, false.

    • Read bytes from the current raw value.

      Parameters

      • buffer: Uint8Array

        the buffer to read data into.

      • offset: number

        the offset into the buffer to start reading data.

      • count: number

        the number of bytes to read.

      Returns number

      the number of bytes read into the buffer.

    • Read characters from the current text value.

      Parameters

      • buffer: string[]

        the buffer to read data into.

      • offset: number

        the offset into the buffer to start reading data.

      • count: number

        the number of characters to read.

      Returns number

      the number of characters read into the buffer.

      buffer is invalid or the value is not readable as text.

      offset or count is out of range.

    • Read the current value as a boolean.

      Returns boolean

      the value as a boolean.

      the value cannot be read as a boolean.

    • Read the current value as bytes.

      Returns Uint8Array

      the value as a byte array.

      the value cannot be read as bytes.

    • Read the current value as a date and time.

      Returns Date

      the value as a date.

      the value cannot be read as a date.

    • Read the current value as a double.

      Returns number

      the value as a number.

      the value cannot be read as a number.

    • Read the current value as a float.

      Returns number

      the value as a number.

      the value cannot be read as a number.

    • Read the current value as a signed 16-bit integer.

      Returns number

      the value as a 16-bit integer.

      the value cannot be read as an integer.

    • Read the current value as a signed 32-bit integer.

      Returns number

      the value as a 32-bit integer.

      the value cannot be read as an integer.

    • Read the current value as a signed 64-bit integer.

      Returns number

      the value as a 64-bit integer.

      the value cannot be read as an integer.

    • Read the current value as a GUID string.

      Returns string

      the value as a GUID.

      the value cannot be read as a GUID.

    • Read the current value as a string.

      Returns string

      the value as a string.

      the value cannot be read as a string.

    • Read the current value as a URL or relative URI string.

      Returns string | URL | null

      the value as a URL, a relative URI string, or null.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods