Interface AliasEndpoints

Interface for all Alias endpoints.

interface AliasEndpoints {
    create(payload: AliasAttributes): Promise<MailcowResponse>;
    createTimeLimited(
        payload: TimeLimitedAliasPostRequest,
    ): Promise<MailcowResponse>;
    delete(payload: AliasDeleteRequest): Promise<MailcowResponse>;
    deleteTimeLimited(
        payload: TimeLimitedAliasDeleteRequest,
    ): Promise<MailcowResponse>;
    edit(payload: AliasEditRequest): Promise<MailcowResponse>;
    editTimeLimited(
        payload: TimeLimitedAliasEditRequest,
    ): Promise<MailcowResponse>;
    get(id?: number | "all"): Promise<Alias[]>;
    getTimeLimited(mailbox: string): Promise<TimeLimitedAlias[]>;
}

Index

Methods

create createTimeLimited delete deleteTimeLimited edit editTimeLimited get getTimeLimited

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:29

createTimeLimited

createTimeLimited(
payload: TimeLimitedAliasPostRequest,
): Promise<MailcowResponse>
Endpoint for creating a time-limited (burner) alias. Mailcow always generates the address itself -- there is no way to request a specific one. The generated address is not returned; call getTimeLimited to retrieve it.
Parameters
- payload: TimeLimitedAliasPostRequest
  The creation payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/alias-endpoints.ts:50

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:41

deleteTimeLimited

deleteTimeLimited(
payload: TimeLimitedAliasDeleteRequest,
): Promise<MailcowResponse>
Endpoint for deleting one or more time-limited aliases.
Parameters
- payload: TimeLimitedAliasDeleteRequest
  The deletion payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/alias-endpoints.ts:70

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:35

editTimeLimited

editTimeLimited(payload: TimeLimitedAliasEditRequest): Promise<MailcowResponse>
Endpoint for extending a time-limited alias's expiry, or marking it permanent. Mailcow silently no-ops if neither validity nor permanent is provided in the payload.
Parameters
- payload: TimeLimitedAliasEditRequest
  The edit payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/alias-endpoints.ts:64

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:23

getTimeLimited

getTimeLimited(mailbox: string): Promise<TimeLimitedAlias[]>
Endpoint for listing the active time-limited aliases for a mailbox.
Parameters
- mailbox: string
  The mailbox to list time-limited aliases for.
Returns Promise<TimeLimitedAlias[]>
- Defined in src/endpoints/alias-endpoints.ts:56