@yoshteq/ti365-ts-sdk
    Preparing search index...

    Class KimMail

    Represents a Kim mail with content and attachment information

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    kimStoredMail isHtmlBody body bodyHtml bodyText processingInfos processingWarnings processingErrors attachmentInfos rawMail kimStoredMailMetadata pop3ServerUid storageId messageId sentDate receivedDate hasAttachments hasMailBeenEncrypted hasSignatureBeenValid hasErrors kimVersion kimDienstkennung from subject recipientsTo recipientsCc

    Constructors

    Accessors

    • get kimStoredMail(): KimStoredMail

      The internal metadata object that was used for storage

      Returns KimStoredMail

    • get isHtmlBody(): boolean

      Determines wether the body is of type html or plain-text

      Returns boolean

    body

    • get body(): string

      The content of the mail (html or plain-text)

      Returns string

    • get bodyHtml(): undefined | string

      The html content of the mail, if present

      Returns undefined | string

    • get bodyText(): undefined | string

      The plain-text content of the mail, if present

      Returns undefined | string

    • get processingInfos(): KimMessageLog[]

      An array of log messages from the decryption and verification process of type "info"

      Returns KimMessageLog[]

    • get processingWarnings(): KimMessageLog[]

      An array of log messages from the decryption and verification process of type "warn"

      Returns KimMessageLog[]

    • get processingErrors(): KimMessageLog[]

      An array of log messages from the decryption and verification process of type "error"

      Returns KimMessageLog[]

    • get rawMail(): KimStoredMail

      The raw mail information in the storage after processing

      Returns KimStoredMail

    • get kimStoredMailMetadata(): KimStoredMailMetadata

      The internal metadata object that was used for storage

      Returns KimStoredMailMetadata

    • get pop3ServerUid(): string

      The messageId of the mail

      Returns string

    • get storageId(): string

      The id of the mail in the storage

      Returns string

    • get messageId(): string

      The messageId of the mail

      Returns string

    • get sentDate(): Date

      The date when the message was sent

      Returns Date

    • get receivedDate(): Date

      The date when the message was received

      Returns Date

    • get hasAttachments(): boolean

      Determines wether the mail has attachments

      Returns boolean

    • get hasMailBeenEncrypted(): boolean

      Determines wether the mail was decrypted from an encrypted KIM mail

      Returns boolean

    • get hasSignatureBeenValid(): boolean

      Determines wether the signature of mail was valid

      Returns boolean

    • get hasErrors(): boolean

      Determines wether there were processing errors

      Returns boolean

    • get kimVersion(): string

      The KIM Version specified in the mail header X-KOM-LE-Version

      Returns string

    • get kimDienstkennung(): string

      The KIM Dienstkennung specified in the mail header X-KIM-Dienstkennung

      Returns string

    • get from(): MailAddressType

      The sender of the mail

      Returns MailAddressType

    • get subject(): string

      The subject of the mail

      Returns string

    • get recipientsTo(): MailAddressType[]

      The recipients to-addresses to whom the mail was sent

      Returns MailAddressType[]

    • get recipientsCc(): MailAddressType[]

      The recipients cc-addresses to whom the mail was sent

      Returns MailAddressType[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors