Interface AppPasswordEndpoints

Interface for all App Password endpoints related to email handling in Mailcow.

interface AppPasswordEndpoints {
    add(payload: AddAppPasswordRequest): Promise<MailcowResponse>;
    delete(payload: DeleteAppPasswordRequest): Promise<MailcowResponse>;
    get(mailbox: string): Promise<AppPassword[]>;
}

Index

Methods

Methods

add

add(payload: AddAppPasswordRequest): Promise<MailcowResponse>
Adds a new app password.
Parameters
- payload: AddAppPasswordRequest
  Object containing the app password details.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/app-password-endpoints.ts:12

delete

delete(payload: DeleteAppPasswordRequest): Promise<MailcowResponse>
Deletes specified app passwords.
Parameters
- payload: DeleteAppPasswordRequest
  Object containing a list of app password IDs to delete.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/app-password-endpoints.ts:18

get

get(mailbox: string): Promise<AppPassword[]>
Retrieves app passwords for a specific mailbox.
Parameters
- mailbox: string
  The mailbox for which to retrieve app passwords.
Returns Promise<AppPassword[]>
A promise that resolves to an array of AppPassword objects.
- Defined in src/endpoints/app-password-endpoints.ts:25