Interface AntiSpamEndpoints

Interface for all antispam policies.

interface AntiSpamEndpoints {
    create(payload: SpamPolicyPostRequest): Promise<MailcowResponse>;
    delete(payload: SpamPolicyDeleteRequest): Promise<MailcowResponse>;
    get(payload: SpamPolicyGetRequest): Promise<SpamPolicy[]>;
}

Index

Methods

create delete get

Methods

create

create(payload: SpamPolicyPostRequest): Promise<MailcowResponse>
Endpoint for creating antispam policies.
Parameters
- payload: SpamPolicyPostRequest
  The creation payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/antispam-endpoints.ts:24

delete

delete(payload: SpamPolicyDeleteRequest): Promise<MailcowResponse>
Endpoint for deleting antispam policies.
Parameters
- payload: SpamPolicyDeleteRequest
  The deletion payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/antispam-endpoints.ts:30

get

get(payload: SpamPolicyGetRequest): Promise<SpamPolicy[]>
Endpoint for getting antispam policies.
Parameters
- payload: SpamPolicyGetRequest
  The get payload.
Returns Promise<SpamPolicy[]>
- Defined in src/endpoints/antispam-endpoints.ts:18