Interface RatelimitsEndpoints

Interface for all Rate Limit endpoints related to email handling in Mailcow.

interface RatelimitsEndpoints {
    editDomain(payload: EditDomainRequest): Promise<MailcowResponse>;
    editMailbox(payload: EditMailboxRequest): Promise<MailcowResponse>;
    getDomain(domain: string): Promise<DomainRatelimit[]>;
    getDomain(domain: "all"): Promise<DomainRatelimit[]>;
    getMailbox(mailbox: string): Promise<MailboxRatelimit[]>;
    getMailbox(mailbox: "all"): Promise<MailboxRatelimit[]>;
}

Index

Methods

editDomain editMailbox getDomain getMailbox

Methods

editDomain

editDomain(payload: EditDomainRequest): Promise<MailcowResponse>
Edits the rate limits for specified domains.
Parameters
- payload: EditDomainRequest
  Object containing rate limit attributes and list of domain names.
Returns Promise<MailcowResponse>
A promise that resolves to a response indicating success or failure.
- Defined in src/endpoints/ratelimit-endpoints.ts:14

editMailbox

editMailbox(payload: EditMailboxRequest): Promise<MailcowResponse>
Edits the rate limits for specified mailboxes.
Parameters
- payload: EditMailboxRequest
  Object containing rate limit attributes and list of mailbox names.
Returns Promise<MailcowResponse>
A promise that resolves to a response indicating success or failure.
- Defined in src/endpoints/ratelimit-endpoints.ts:21

getDomain

getDomain(domain: string): Promise<DomainRatelimit[]>
Retrieves the rate limits for a specified domain or all domains.
Parameters
- domain: string
Returns Promise<DomainRatelimit[]>
- Defined in src/endpoints/ratelimit-endpoints.ts:26
getDomain(domain: "all"): Promise<DomainRatelimit[]>
Parameters
- domain: "all"
Returns Promise<DomainRatelimit[]>
- Defined in src/endpoints/ratelimit-endpoints.ts:27

getMailbox

getMailbox(mailbox: string): Promise<MailboxRatelimit[]>
Retrieves the rate limits for a specified mailbox or all mailboxes.
Parameters
- mailbox: string
Returns Promise<MailboxRatelimit[]>
- Defined in src/endpoints/ratelimit-endpoints.ts:32
getMailbox(mailbox: "all"): Promise<MailboxRatelimit[]>
Parameters
- mailbox: "all"
Returns Promise<MailboxRatelimit[]>
- Defined in src/endpoints/ratelimit-endpoints.ts:33