Interface DomainEndpoints

Interface for all Domain endpoints.

interface DomainEndpoints {
    create(payload: DomainPostRequest): Promise<MailcowResponse>;
    delete(payload: DomainDeleteRequest): Promise<MailcowResponse>;
    deleteTag(
        domain: string,
        payload: DomainTagDeleteRequest,
    ): Promise<MailcowResponse>;
    edit(payload: DomainEditRequest): Promise<MailcowResponse>;
    editFooter(payload: DomainFooterEditRequest): Promise<MailcowResponse>;
    get(domain: string): Promise<Domain[]>;
}

Index

Methods

create delete deleteTag edit editFooter get

Methods

create

create(payload: DomainPostRequest): Promise<MailcowResponse>
Endpoint for creating domains.
Parameters
- payload: DomainPostRequest
  The creation payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/domain-endpoints.ts:27

delete

delete(payload: DomainDeleteRequest): Promise<MailcowResponse>
Endpoint for deleting a domain.
Parameters
- payload: DomainDeleteRequest
  The deletion payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/domain-endpoints.ts:33

deleteTag

deleteTag(
domain: string,
payload: DomainTagDeleteRequest,
): Promise<MailcowResponse>
Endpoint for removing one or more tags from a domain.
Parameters
- domain: string
  The domain to remove tags from.
- payload: DomainTagDeleteRequest
  The tags to remove.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/domain-endpoints.ts:46

edit

edit(payload: DomainEditRequest): Promise<MailcowResponse>
Endpoint for editing a domain.
Parameters
- payload: DomainEditRequest
  The edit payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/domain-endpoints.ts:39

editFooter

editFooter(payload: DomainFooterEditRequest): Promise<MailcowResponse>
Endpoint for setting the domain-wide mail footer template.
Parameters
- payload: DomainFooterEditRequest
  The edit payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/domain-endpoints.ts:52

get

get(domain: string): Promise<Domain[]>
Endpoint for getting domains.
Parameters
- domain: string
  Name of the domain to get.
Returns Promise<Domain[]>
- Defined in src/endpoints/domain-endpoints.ts:21