Interface CanonicalEmailBlocksResource

interface CanonicalEmailBlocksResource {
    $select(id: string): CanonicalEmailBlocks$SelectResource;
    create(
        params: CreateCanonicalEmailBlockParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<CanonicalEmailBlock>;
    list(
        params?: DefaultPaginationParams,
        meta?: HttpMetaParams<"none">,
    ): Paginator<CanonicalEmailBlock[], DefaultPaginationParams>;
    test(
        params: TestCanonicalEmailBlockParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<CanonicalEmailBlock[]>;
}

Index

Methods

$select create list test

Methods

$select

$select(id: string): CanonicalEmailBlocks$SelectResource
Parameters
- id: string
Returns CanonicalEmailBlocks$SelectResource
- Defined in src/mastodon/rest/v1/admin/canonical-email-blocks.ts:42

create

create(
params: CreateCanonicalEmailBlockParams,
meta?: HttpMetaParams<"json">,
): Promise<CanonicalEmailBlock>
Block a canonical email.
Parameters
- params: CreateCanonicalEmailBlockParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<CanonicalEmailBlock>
CanonicalEmailBlock

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

list

list(
params?: DefaultPaginationParams,
meta?: HttpMetaParams<"none">,
): Paginator<CanonicalEmailBlock[], DefaultPaginationParams>
List all canonical email blocks.
Parameters
- Optionalparams: DefaultPaginationParams
  Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<CanonicalEmailBlock[], DefaultPaginationParams>
Array of CanonicalEmailBlock

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

test

test(
params: TestCanonicalEmailBlockParams,
meta?: HttpMetaParams<"json">,
): Promise<CanonicalEmailBlock[]>
Canonicalize and hash an email address.
Parameters
- params: TestCanonicalEmailBlockParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<CanonicalEmailBlock[]>
Array of CanonicalEmailBlock

See
https://docs.joinmastodon.org/methods/admin/canonical_email_blocks/#test
- Defined in src/mastodon/rest/v1/admin/canonical-email-blocks.ts:61