Class Pop3Mail

constructor

• new Pop3Mail(
      socket: TlsWebSocket,
      reader: SocketReader,
      id: string,
      size?: number,
      uid?: string,
  ): Pop3Mail

  Parameters

  • socket: TlsWebSocket
  • reader: SocketReader
  • id: string
  • Optionalsize: number
  • Optionaluid: string

  Returns Pop3Mail

Optionalheaders

getId

• getId(): string

  Returns string

getUid

• getUid(): undefined | string

  Returns undefined | string

loadUid

• loadUid(): Promise<string>

  Returns Promise<string>

getSize

• getSize(): undefined | number

  Returns undefined | number

  Total size of the mail in bytes.

loadSize

• loadSize(): Promise<number>

  Returns Promise<number>

headersLoaded

• headersLoaded(): boolean

  States if Headers are loaded.

  Returns boolean

  true If headers are loaded

getHeaders

• getHeaders(): Promise<MailHeaders>

  Loads the headers of the Mail.

  Returns Promise<MailHeaders>

  Promise

delete

• delete(): Promise<void>

  Marks a Mail to be deleted at the end of the session. This mail will only be deleted if you call quit on the Pop3Session

  Returns Promise<void>

getMail

• getMail(): Promise<Mail>

  Loads the complete MIME Mail as an one ArrayBuffer.

  Returns Promise<Mail>

  Array Buffer containing the whole mail.

getMailSplitted

• getMailSplitted(
      bufferSize: number,
      callback: (data: Uint8Array) => Promise<unknown>,
  ): Promise<void>

  Loads a mail in smaller buffer chunks. This buffers have all the given size, besides the last one which can be smaller.

  Parameters

  • bufferSize: number

    The max size of the data buffer in bytes.

  • callback: (data: Uint8Array) => Promise<unknown>

    Method that will be called if one data buffer is ready. The new Buffer will be delivered after it has been resolved.

  Returns Promise<void>