Class Backup

Hierarchy

Backup

Implements

Middleware

Index

Constructors

Accessors

Methods

handle key retrieve save

Constructors

constructor

new Backup(config): Backup
Parameters
- config: BackupConfig
Returns Backup
- Defined in backup.ts:8

Properties

`Protected` config

config: BackupConfig

Accessors

name

get name(): string
Returns string
Implementation of Middleware.name
- Defined in backup.ts:10

Methods

handle

handle(ctx, next): Promise<void>
Parameters
- ctx: Context
- next: (() => Promise<void>)
  - - (): Promise<void>
    - Returns Promise<void>
Returns Promise<void>
Implementation of Middleware.handle
- Defined in backup.ts:14

key

key(message_id, from, to): string
Generates a key for storing the email message.
Parameters
- message_id: string
  The ID of the email message.
- from: string
  The email address of the sender.
- to: string
  The email address of the recipient.
Returns string
A string representing the unique key for the email message.
- Defined in backup.ts:89

retrieve

retrieve(message_id, from, to): Promise<null | (() => Promise<ArrayBuffer>)>
Retrieves a raw message from the bucket.
Parameters
- message_id: string
  The ID of the message to retrieve.
- from: string
  The sender of the message.
- to: string
  The recipient of the message.
Returns Promise<null | (() => Promise<ArrayBuffer>)>
A function that returns the raw message as an ArrayBuffer, or null if the message was not found.
- Defined in backup.ts:102

save

save(message_id, from, to, body): Promise<void>
Saves an email message to the backup storage.
Parameters
- message_id: undefined | null | string
  The ID of the message to save. If null or undefined, a new ID will be generated.
- from: string
  The email address of the sender.
- to: string
  The email address of the recipient.
- body: string | Uint8Array
  The body of the email message.
Returns Promise<void>
- Defined in backup.ts:46

Generated using TypeDoc