documentation/email_domain_blocks.md at 61bcd7de894f4d089084504345b905d08183c399

mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00

* add rules

* join date on profiles

* deprecate follow scope

* deprecate identity proofs

* familiar followers

* use definition lists instead of tables for defining activitypub properties

* reformat notifications page into markdown

* fix broken links to publicKey header

* Application website is now nullable

* update environment variables added and removed

* fix typo

* fix heading level

* min_id and max_id can be used at the same time (3.3)

* fix typo

* new tootctl options

* reformat tootctl page to use definition lists for params

* add rules and configuration to Instance

* fix typo

* refactor instance api page

* 3.3.0 duration on mutes

* 3.3.0 mute_expires_at

* improve section headings

* 3.4.0 resend email confirmation api

* 3.4.0 policy on push subscriptions

* 3.4.0 add details to account registration error

* refactor accounts api page and start adding relrefs to entity pages

* 3.4.0 accounts/lookup api

* add see also to accounts methods

* add more see-also links

* 3.5.0 appeal mod decisions

* 3.5.0 reformat reports and add category/rule_ids params

* document report entity and missing responses

* fix typos

* fix relrefs and url schema, add aliases to old urls

* add archetypes for new methods/entities

* update archetypes with see-also stubs

* clearer presentation of rate limits

* announcements api methods

* refactor apps methods

* refactor bookmarks methods + some anchors

* refactor conversations methods

* custom_emojis methods refactor

* anchors

* refactor directory methods

* refactor domain_blocks methods

* add see also to emails methods

* fix page relref shortcodes to specific methods + refactor endorsements methods

* min_id max_id

* refactor favourites methods

* refactor featured_tags methods

* refactor filters methods, make path params consistent, i18n required shortcode

* follow_requests methods

* lists methods

* markers methods

* forgot to add entity links

* media methods, also fix formatting of some json errors

* mutes methods, add more see-also links

* oembed methods

* preferences methods

* proofs methods

* push methods

* suggestions methods

* 3.5.0 add new trend types, fix formatting

* refactor streaming methods

* refactor oauth methods

* note that streaming api casts payload to string

* refactor search methods

* refactor polls methods

* remove unnecessary link

* reformat scheduled_statuses methods

* reformat timelines methods

* reformat statuses methods

* 3.5.0 editing statuses

* consistent use of array brackets in form data parameters

* update dev setup guide, add vagrant and clean up text

* add admin/accounts methods

* 3.6 role entity

* admin/accounts methods v2

* minor fix

* stub admin/reports methods

* document admin reports

* add 403 example to methods archetype

* cleanup entities for admin reports and add new attrs

* 3.6.0 domain allows methods + normalize admin entity namespace

* fix search-and-replace error

* add aliases for admin entities

* 3.6.0 canonical email blocks entity

* 3.5.0 admin/retention api

* 3.5.0 add admin::ip doc

* 3.5.0 admin/reports

* 3.6.0 admin/domain_allows

* 3.5.0 admin/dimensions

* 3.6.0 permissions and roles

* minor formatting fix

* add anchor link to headings

* checkpoint

* add update commands to dev env setup guide

* change mentions of v3.6 to v4.0

* tootctl now uses custom roles

* fix formatting

* v2 instance api

* update frontmatter, add better titles to pages

* minor wording change

* consistency

* add more aliases

* add placeholders and WIP notices

* explain link pagination and stub out todos

* switch baseURL to https

* 422 on reports with rules but category!=violation

* document bug fixes

* fix typo

* remove duplicate API method definition

* s/tootsuite/mastodon for github links

* remove unnecessary escaping

* s/tootsuite/mastodon in Entity archetype

* add missing nullable shortcode

* clarify oauth scope when requesting a user token

* api/v2/media now synchronous for images

* DISALLOW_UNAUTHENTICATED_API_ACCESS

* add undocumented env variables

* add instance domain blocks and extended description api

* add SMTP_ENABLE_STARTTLS

* add description to SMTP_ENABLE_STARTTLS

* take suggestions from open PRs

* normalize links and flavour language

* Fully document streaming API based on source code

* Add mention of MIME types

* bump to ruby 3.0.4

* clarify how to check on async media processing

* validation of replies_policy

* remove TODOs on admin account action

* EmailDomainBlocks

* IpBlocks

* Admin::DomainBlock

* remove TODOs

* following hashtags

* followed_tags

* remove reference to unused parameter

* add new oauth scopes for admin blocks and allows

* fix command signature for i18n-tasks normalize

* reformat code structure page

* document fixes for following tags (assume 4.0.3)

* Add warning about pre-4.0 hardcoded roles

* add note about case sensitivity

* remove use of 'simply' from docs

* remove reference to silencing

* add reference to IDN normalization for verified links

* add lang parameter

2022-11-20 07:34:38 +01:00

6.8 KiB

Raw Blame History

title

description

aliases

email_domain_blocks API methods

Disallow certain email domains from signing up.

docs

name	parent	identifier
email_domain_blocks	methods-admin	methods-admin-email_domain_blocks

/methods/admin/email_domain_blocks

/api/methods/admin/email_domain_blocks

{{< hint style="danger" >}} This page is under construction. {{< /hint >}}

List all blocked email domains

GET https://mastodon.example/api/v1/admin/email_domain_blocks HTTP/1.1

Show information about all email domains blocked from signing up.

Returns: Array of [Admin::EmailDomainBlock]({{< relref "entities/Admin_EmailDomainBlock" >}})
OAuth: User token + admin:read:email_domain_blocks
Permissions: Manage Blocks
Version history:
4.0.0 - added

Request

Headers

Authorization: {{}} Provide this header with Bearer <user token> to gain authorized access to this API method.

Query parameters

limit: Integer. Maximum number of results to return. Defaults to 100.

Response

200: OK

[
  {
    "id": "1",
    "domain": "foo",
    "created_at": "2022-11-16T06:09:36.176Z",
    "history": [
      {
        "day": "1668556800",
        "accounts": "0",
        "uses": "0"
      },
      {
        "day": "1668470400",
        "accounts": "0",
        "uses": "0"
      },
      {
        "day": "1668384000",
        "accounts": "0",
        "uses": "0"
      },
      {
        "day": "1668297600",
        "accounts": "0",
        "uses": "0"
      },
      {
        "day": "1668211200",
        "accounts": "0",
        "uses": "0"
      },
      {
        "day": "1668124800",
        "accounts": "0",
        "uses": "0"
      },
      {
        "day": "1668038400",
        "accounts": "0",
        "uses": "0"
      }
    ]
  },
  // ...
]

403: Forbidden

Authorized user is not allowed to perform this action, or invalid or missing Authorization header

{
  "error": "This action is not allowed"
}

Get a single blocked email domain

GET https://mastodon.example/api/v1/admin/email_domain_blocks/:id HTTP/1.1

Show information about a single email domain that is blocked from signups.

Returns: [Admin::EmailDomainBlock]({{< relref "entities/Admin_EmailDomainBlock" >}})
OAuth: User token + admin:read:email_domain_blocks
Permissions: Manage Blocks
Version history:
4.0.3 - added

Path parameters

:id: {{}} String. The ID of the DomainBlock in the database.

Headers

Authorization: {{}} Provide this header with Bearer <user token> to gain authorized access to this API method.

Response

200: OK

{
  "id": "1",
  "domain": "foo",
  "created_at": "2022-11-16T06:09:36.176Z",
  "history": [
    {
      "day": "1668556800",
      "accounts": "0",
      "uses": "0"
    },
    {
      "day": "1668470400",
      "accounts": "0",
      "uses": "0"
    },
    {
      "day": "1668384000",
      "accounts": "0",
      "uses": "0"
    },
    {
      "day": "1668297600",
      "accounts": "0",
      "uses": "0"
    },
    {
      "day": "1668211200",
      "accounts": "0",
      "uses": "0"
    },
    {
      "day": "1668124800",
      "accounts": "0",
      "uses": "0"
    },
    {
      "day": "1668038400",
      "accounts": "0",
      "uses": "0"
    }
  ]
}

403: Forbidden

Authorized user is not allowed to perform this action, or invalid or missing Authorization header

{
  "error": "This action is not allowed"
}

404: Not found

EmailDomainBlock with the given ID does not exist

{
	"error": "Record not found"
}

Block an email domain from signups

POST https://mastodon.example/api/v1/admin/email_domain_blocks HTTP/1.1

Add a domain to the list of email domains blocked from signups.

Returns: [Admin::EmailDomainBlock]({{< relref "entities/Admin_EmailDomainBlock" >}})
OAuth: User token + admin:write:email_domain_blocks
Permissions: Manage Blocks
Version history:
4.0.0 - added

Request

Headers

Authorization: {{}} Provide this header with Bearer <user token> to gain authorized access to this API method.

Form data parameters

domain: {{}} String. The domain to block federation with.

Response

200: OK

Email domain has been blocked from signups.

{
  "id": "1",
  "domain": "foo",
  "created_at": "2022-11-16T06:09:36.176Z",
  "history": [
    {
      "day": "1668556800",
      "accounts": "0",
      "uses": "0"
    },
    {
      "day": "1668470400",
      "accounts": "0",
      "uses": "0"
    },
    {
      "day": "1668384000",
      "accounts": "0",
      "uses": "0"
    },
    {
      "day": "1668297600",
      "accounts": "0",
      "uses": "0"
    },
    {
      "day": "1668211200",
      "accounts": "0",
      "uses": "0"
    },
    {
      "day": "1668124800",
      "accounts": "0",
      "uses": "0"
    },
    {
      "day": "1668038400",
      "accounts": "0",
      "uses": "0"
    }
  ]
}

403: Forbidden

Authorized user is not allowed to perform this action, or invalid or missing Authorization header

{
  "error": "This action is not allowed"
}

422: Unprocessable entity

The domain parameter was not provided

{
	"error": "Validation failed: Domain can't be blank"
}

Alternatively, the domain provided contains an invalid character

{
  "error": "Validation failed: Domain is invalid, Domain is not a valid domain name"
}

Delete an email domain block

DELETE https://mastodon.example/api/v1/admin/email_domain_blocks/:id HTTP/1.1

Lift a block against an email domain.

Request

Path parameters

:id: {{}} String. The ID of the DomainAllow in the database.

Headers

Authorization: {{}} Provide this header with Bearer <user token> to gain authorized access to this API method.

Response

200: OK

The email domain has been removed from the block list

{}

403: Forbidden

Authorized user is not allowed to perform this action, or invalid or missing Authorization header

{
  "error": "This action is not allowed"
}

404: Not found

EmailDomainBlock with the given ID does not exist

{
	"error": "Record not found"
}

6.8 KiB Raw Blame History

List all blocked email domains

Request

Headers

Query parameters

Response

200: OK

403: Forbidden

Get a single blocked email domain

Path parameters

Headers

Response

200: OK

403: Forbidden

404: Not found

Block an email domain from signups

Request

Headers

Form data parameters

Response

200: OK

403: Forbidden

422: Unprocessable entity

Delete an email domain block

Request

Path parameters

Headers

Response

200: OK

403: Forbidden

404: Not found

See also

6.8 KiB

Raw Blame History