Interface DkimEndpoints

Interface for all DKIM endpoints related to Mailcow.

interface DkimEndpoints {
    create(payload: CreateDkimRequest): Promise<MailcowResponse>;
    delete(payload: DeleteDkimRequest): Promise<MailcowResponse>;
    duplicate(payload: DuplicateDkimRequest): Promise<MailcowResponse>;
    get(domain: string): Promise<DkimEntry>;
}

Index

Methods

create delete duplicate get

Methods

create

create(payload: CreateDkimRequest): Promise<MailcowResponse>
Generates new DKIM keys for specified domains.
Parameters
- payload: CreateDkimRequest
  Object containing details for the DKIM key generation.
Returns Promise<MailcowResponse>
A promise that resolves to a response indicating success or failure.
- Defined in src/endpoints/dkim-endpoints.ts:13

delete

delete(payload: DeleteDkimRequest): Promise<MailcowResponse>
Deletes DKIM keys for specified domains.
Parameters
- payload: DeleteDkimRequest
  Object containing a list of domains to delete DKIM keys for.
Returns Promise<MailcowResponse>
A promise that resolves to a response indicating success or failure.
- Defined in src/endpoints/dkim-endpoints.ts:27

duplicate

duplicate(payload: DuplicateDkimRequest): Promise<MailcowResponse>
Duplicates a DKIM key from one domain to another.
Parameters
- payload: DuplicateDkimRequest
  Object containing source and destination domains for the DKIM key.
Returns Promise<MailcowResponse>
A promise that resolves to a response indicating success or failure.
- Defined in src/endpoints/dkim-endpoints.ts:20

get

get(domain: string): Promise<DkimEntry>
Retrieves the DKIM public key for a specific domain.
Parameters
- domain: string
  The domain to retrieve the DKIM key for.
Returns Promise<DkimEntry>
A promise that resolves to a DkimEntry object.
- Defined in src/endpoints/dkim-endpoints.ts:34