Interface AliasEndpoints

Interface for all Alias endpoints.

interface AliasEndpoints {
    create(payload: AliasAttributes): Promise<MailcowResponse>;
    delete(payload: AliasDeleteRequest): Promise<MailcowResponse>;
    edit(payload: AliasEditRequest): Promise<MailcowResponse>;
    get(id?: number | "all"): Promise<Alias[]>;
}

Index

Methods

create delete edit get

Methods

create

create(payload: AliasAttributes): Promise<MailcowResponse>
Endpoint for creating mailbox aliases.
Parameters
- payload: AliasAttributes
  The creation payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/alias-endpoints.ts:19

delete

delete(payload: AliasDeleteRequest): Promise<MailcowResponse>
Endpoint for deleting a mailbox alias.
Parameters
- payload: AliasDeleteRequest
  The deletion payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/alias-endpoints.ts:31

edit

edit(payload: AliasEditRequest): Promise<MailcowResponse>
Endpoint for editing a mailbox alias.
Parameters
- payload: AliasEditRequest
  The edit payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/alias-endpoints.ts:25

get

get(id?: number | "all"): Promise<Alias[]>
Endpoint for getting mailbox aliases in the system.
Parameters
- Optionalid: number | "all"
  The id of the alias you want to get. Use 'all' to retrieve all aliases in the system.
Returns Promise<Alias[]>
- Defined in src/endpoints/alias-endpoints.ts:13