Interface MailboxEndpoints

Interface for all Mailbox endpoints.

interface MailboxEndpoints {
    create(payload: MailboxPostRequest): Promise<MailcowResponse>;
    delete(payload: MailboxDeleteRequest): Promise<MailcowResponse>;
    deleteTag(
        mailbox: string,
        payload: MailboxTagDeleteRequest,
    ): Promise<MailcowResponse>;
    edit(payload: MailboxEditRequest): Promise<MailcowResponse>;
    editCustomAttribute(
        payload: MailboxCustomAttributeEditRequest,
    ): Promise<MailcowResponse>;
    editPushover(payload: PushoverEditRequest): Promise<MailcowResponse>;
    editQuarantine(payload: QuarantineEditRequest): Promise<MailcowResponse>;
    editSpamScore(payload: SpamScoreEditRequest): Promise<MailcowResponse>;
    editUserACL(payload: ACLEditRequest): Promise<MailcowResponse>;
    get(mailbox: "all"): Promise<Mailbox[]>;
    get(mailbox: string): Promise<Mailbox[]>;
    getActiveUserSieve(mailbox: string): Promise<string[]>;
    getByDomain(domain: string): Promise<Mailbox[]>;
    getSpamScore(mailbox?: string): Promise<SpamScoreGetResponse>;
}

Index

Methods

create delete deleteTag edit editCustomAttribute editPushover editQuarantine editSpamScore editUserACL get getActiveUserSieve getByDomain getSpamScore

Methods

create

create(payload: MailboxPostRequest): Promise<MailcowResponse>
Endpoint for creating a mailbox.
Parameters
- payload: MailboxPostRequest
  The creation payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/mailbox-endpoint.ts:26

delete

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

deleteTag

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

edit

edit(payload: MailboxEditRequest): Promise<MailcowResponse>
Endpoint for editing a mailbox.
Parameters
- payload: MailboxEditRequest
Returns Promise<MailcowResponse>
- Defined in src/endpoints/mailbox-endpoint.ts:38

editCustomAttribute

editCustomAttribute(
payload: MailboxCustomAttributeEditRequest,
): Promise<MailcowResponse>
Endpoint for writing custom attributes on one or more mailboxes.
Parameters
- payload: MailboxCustomAttributeEditRequest
  The edit payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/mailbox-endpoint.ts:88

editPushover

editPushover(payload: PushoverEditRequest): Promise<MailcowResponse>
Endpoint for editing a mailbox's pushover settings.
Parameters
- payload: PushoverEditRequest
  The edit payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/mailbox-endpoint.ts:51

editQuarantine

editQuarantine(payload: QuarantineEditRequest): Promise<MailcowResponse>
Endpoint for editing a mailbox's quarantine settings.
Parameters
- payload: QuarantineEditRequest
  The edit payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/mailbox-endpoint.ts:57

editSpamScore

editSpamScore(payload: SpamScoreEditRequest): Promise<MailcowResponse>
Endpoint for editing a mailbox's spam score settings.
Parameters
- payload: SpamScoreEditRequest
  The edit payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/mailbox-endpoint.ts:63

editUserACL

editUserACL(payload: ACLEditRequest): Promise<MailcowResponse>
Endpoint for editing a mailbox's ACL settings.
Parameters
- payload: ACLEditRequest
  The edit payload.
Returns Promise<MailcowResponse>
- Defined in src/endpoints/mailbox-endpoint.ts:69

get

get(mailbox: "all"): Promise<Mailbox[]>
Endpoint for getting a mailbox.
Parameters
- mailbox: "all"
  The mailbox to get
Returns Promise<Mailbox[]>
- Defined in src/endpoints/mailbox-endpoint.ts:44
get(mailbox: string): Promise<Mailbox[]>
Parameters
- mailbox: string
Returns Promise<Mailbox[]>
- Defined in src/endpoints/mailbox-endpoint.ts:45

getActiveUserSieve

getActiveUserSieve(mailbox: string): Promise<string[]>
Endpoint fot getting a mailbox's active sieve.
Parameters
- mailbox: string
  The mailbox to get.
Returns Promise<string[]>
- Defined in src/endpoints/mailbox-endpoint.ts:75

getByDomain

getByDomain(domain: string): Promise<Mailbox[]>
Endpoint for listing all mailboxes belonging to a specific domain.
Parameters
- domain: string
  The domain to filter mailboxes by.
Returns Promise<Mailbox[]>
- Defined in src/endpoints/mailbox-endpoint.ts:101

getSpamScore

getSpamScore(mailbox?: string): Promise<SpamScoreGetResponse>
Endpoint for reading a mailbox's spam score override.
Parameters
- Optionalmailbox: string
  The mailbox to get the score for, or omit/empty for the global score (admin only).
Returns Promise<SpamScoreGetResponse>
- Defined in src/endpoints/mailbox-endpoint.ts:95

Interface MailboxEndpoints

Index

Methods

Methods

create

Parameters

Returns Promise<MailcowResponse>

delete

Parameters

Returns Promise<MailcowResponse>

deleteTag

Parameters

Returns Promise<MailcowResponse>

edit

Parameters

Returns Promise<MailcowResponse>

editCustomAttribute

Parameters

Returns Promise<MailcowResponse>

editPushover

Parameters

Returns Promise<MailcowResponse>

editQuarantine

Parameters

Returns Promise<MailcowResponse>

editSpamScore

Parameters

Returns Promise<MailcowResponse>

editUserACL

Parameters

Returns Promise<MailcowResponse>

get

Parameters

Returns Promise<Mailbox[]>

Parameters

Returns Promise<Mailbox[]>

getActiveUserSieve

Parameters

Returns Promise<string[]>

getByDomain

Parameters

Returns Promise<Mailbox[]>

getSpamScore

Parameters

Returns Promise<SpamScoreGetResponse>

Settings

On This Page