Interface TlsPolicyMapEndpoints

Interface for all TLS Policy Map endpoints related to Mailcow.

interface TlsPolicyMapEndpoints {
    add(payload: AddTlsPolicyMapRequest): Promise<MailcowResponse>;
    delete(payload: DeleteTlsPolicyMapRequest): Promise<MailcowResponse>;
    get(id: string): Promise<TlsPolicyMap[]>;
    get(id: "all"): Promise<TlsPolicyMap[]>;
}

Index

Methods

Methods

add

add(payload: AddTlsPolicyMapRequest): Promise<MailcowResponse>
Adds a new TLS Policy Map.
Parameters
- payload: AddTlsPolicyMapRequest
  Object containing details for the TLS Policy Map.
Returns Promise<MailcowResponse>
A promise that resolves to a response indicating success or failure.
- Defined in src/endpoints/tls-policy-map-endpoints.ts:13

delete

delete(payload: DeleteTlsPolicyMapRequest): Promise<MailcowResponse>
Deletes specified TLS Policy Maps.
Parameters
- payload: DeleteTlsPolicyMapRequest
  Object containing a list of TLS Policy Map IDs to delete.
Returns Promise<MailcowResponse>
A promise that resolves to a response indicating success or failure.
- Defined in src/endpoints/tls-policy-map-endpoints.ts:20

get

get(id: string): Promise<TlsPolicyMap[]>
Retrieves a TLS Policy Map by ID or all maps.
Parameters
- id: string
  The TLS policy map ID or 'all' to retrieve all maps.
Returns Promise<TlsPolicyMap[]>
A promise that resolves to an array of TlsPolicyMap objects.
- Defined in src/endpoints/tls-policy-map-endpoints.ts:27
get(id: "all"): Promise<TlsPolicyMap[]>
Parameters
- id: "all"
Returns Promise<TlsPolicyMap[]>
- Defined in src/endpoints/tls-policy-map-endpoints.ts:28