List mail settings of a Project

GET/projects/{projectId}/mail-settings/

API version

v2

Request method

GET

Operation ID

mail-list-project-mail-settings

---

Request

• projectIdstring

  required

  ID of the Project to list mail settings for.

Responses

Format

application/json

Description

OK

Schema documentation

• blacklistarray of string (idn-email)

  required
  • Array[
  • *string (idn-email)
  ]

projectIdstring

required

whitelistarray of string (idn-email)

required

• Array[
• *string (idn-email)
]

Example

{
  "blacklist": [
    "email@mittwald.example"
  ],
  "projectId": "string",
  "whitelist": [
    "email@mittwald.example"
  ]
}

JSON Schema

{
  "properties": {
    "blacklist": {
      "items": {
        "format": "idn-email",
        "type": "string"
      },
      "type": "array"
    },
    "projectId": {
      "type": "string"
    },
    "whitelist": {
      "items": {
        "format": "idn-email",
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "projectId",
    "blacklist",
    "whitelist"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/projects/string/mail-settings

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.mail.listProjectMailSettings({
  "projectId": "string"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Mail\ListProjectMailSettings\ListProjectMailSettingsRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ListProjectMailSettingsRequest(
  projectId: "string"
));
$response = $client->mail()->listProjectMailSettings($request);

var_dump($response->getBody();