Interface QuarantineEndpoints

Interface for all Quarantine endpoints related to email handling in Mailcow.

interface QuarantineEndpoints {
    delete(payload: DeleteQuarantineRequest): Promise<MailcowResponse>;
    edit(payload: EditQuarantineItemRequest): Promise<MailcowResponse>;
    get(): Promise<QuarantineItem[]>;
}

Index

Methods

delete edit get

Methods

delete

delete(payload: DeleteQuarantineRequest): Promise<MailcowResponse>
Deletes emails from the quarantine.
Parameters
- payload: DeleteQuarantineRequest
  An array of email IDs to delete from quarantine.
Returns Promise<MailcowResponse>
A promise that resolves to the Mailcow API response indicating success or failure.
- Defined in src/endpoints/quarantine-endpoints.ts:13

edit

edit(payload: EditQuarantineItemRequest): Promise<MailcowResponse>
Acts on quarantined emails: release them to the recipient's inbox or learn them as ham to improve future Rspamd filtering.
Parameters
- payload: EditQuarantineItemRequest
  The IDs to act on and the action to take.
Returns Promise<MailcowResponse>
A promise that resolves to the Mailcow API response indicating success or failure.
- Defined in src/endpoints/quarantine-endpoints.ts:21

get

get(): Promise<QuarantineItem[]>
Retrieves all emails currently held in quarantine.

Returns Promise<QuarantineItem[]>
A promise that resolves to an array of QuarantineItem representing each quarantined email.
- Defined in src/endpoints/quarantine-endpoints.ts:27