Interface EmailDomainBlocksResource

interface EmailDomainBlocksResource {
    $select(id: string): EmailDomainBlocks$SelectResource;
    create(
        params: CreateEmailDomainBlockParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<EmailDomainBlock>;
    list(
        params?: ListEmailDomainBlocksParams,
        meta?: HttpMetaParams<"none">,
    ): Paginator<EmailDomainBlock[], ListEmailDomainBlocksParams>;
}

Index

Methods

$select create list

Methods

$select

$select(id: string): EmailDomainBlocks$SelectResource
Parameters
- id: string
Returns EmailDomainBlocks$SelectResource
- Defined in src/mastodon/rest/v1/admin/email-domain-blocks.ts:32

create

create(
params: CreateEmailDomainBlockParams,
meta?: HttpMetaParams<"json">,
): Promise<EmailDomainBlock>
Add a domain to the list of email domains blocked from sign-ups.
Parameters
- params: CreateEmailDomainBlockParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<EmailDomainBlock>
EmailDomainBlock

See
https://docs.joinmastodon.org/methods/admin/
- Defined in src/mastodon/rest/v1/admin/email-domain-blocks.ts:51

list

list(
params?: ListEmailDomainBlocksParams,
meta?: HttpMetaParams<"none">,
): Paginator<EmailDomainBlock[], ListEmailDomainBlocksParams>
Show information about all email domains blocked from signing up.
Parameters
- Optionalparams: ListEmailDomainBlocksParams
  Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<EmailDomainBlock[], ListEmailDomainBlocksParams>
Array of EmailDomainBlock

See
https://docs.joinmastodon.org/methods/admin/
- Defined in src/mastodon/rest/v1/admin/email-domain-blocks.ts:40