Interface OAuth2Endpoints

Interface for all OAuth2 Client endpoints related to email handling in Mailcow.

interface OAuth2Endpoints {
    add(payload: AddOAuthClientRequest): Promise<MailcowResponse>;
    delete(payload: DeleteOAuthClientRequest): Promise<MailcowResponse>;
    get(payload: GetOAuthClientRequest): Promise<OAuthClient[]>;
}

Index

Methods

Methods

add

add(payload: AddOAuthClientRequest): Promise<MailcowResponse>
Adds a new OAuth client.
Parameters
- payload: AddOAuthClientRequest
  Object containing the redirect URI for the OAuth client.
Returns Promise<MailcowResponse>
A promise that resolves to a response indicating success or failure.
- Defined in src/endpoints/oauth2-endpoints.ts:19

delete

delete(payload: DeleteOAuthClientRequest): Promise<MailcowResponse>
Deletes specified OAuth clients.
Parameters
- payload: DeleteOAuthClientRequest
  Object containing a list of OAuth client IDs to delete.
Returns Promise<MailcowResponse>
A promise that resolves to a response indicating success or failure.
- Defined in src/endpoints/oauth2-endpoints.ts:26

get

get(payload: GetOAuthClientRequest): Promise<OAuthClient[]>
Retrieves an OAuth client by ID or all clients.
Parameters
- payload: GetOAuthClientRequest
  Object containing the OAuth client ID or 'all' to retrieve all clients.
Returns Promise<OAuthClient[]>
A promise that resolves to an array of OAuthClient objects.
- Defined in src/endpoints/oauth2-endpoints.ts:33