Get a mail address

GET/mail-addresses/{mailAddressId}/

API version

v2

Request method

GET

Operation ID

mail-get-mail-address

---

Request

• mailAddressIdstring (uuid)

  required

  ID of the MailAddress to be retrieved.

Responses

Format

application/json

Description

OK

Schema documentation

• addressstring (idn-email)

  required
• autoResponderobject

  required
  • activeboolean

    required
  • expiresAtstring (date-time)
  • messagestring
  • startsAtstring (date-time)
• forwardAddressesarray of string (idn-email)

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

idstring (uuid)

required

isArchivedboolean

required

isCatchAllboolean

required

mailboxobject

• namestring

  required
• passwordUpdatedAtstring (date-time)

  required
• sendingEnabledboolean

  required
• spamProtectionobject

  required
  • activeboolean

    required
  • autoDeleteSpamboolean

    required
  • folderstring (one of: spam, inbox)

    required
  • relocationMinSpamScoreinteger

    required
• storageInBytesobject

  required
  • currentobject

    required
    • updatedAtstring (date-time)

      required
    • valuenumber

      required
  • limitnumber

    required

projectIdstring

required

receivingDisabledboolean

required

updatedAtstring (date-time)

required

Example

{
  "address": "email@mittwald.example",
  "autoResponder": {
    "active": true,
    "expiresAt": "2024-12-18T07:53:15.340Z",
    "message": "string",
    "startsAt": "2024-12-18T07:53:15.340Z"
  },
  "forwardAddresses": [
    "email@mittwald.example"
  ],
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "isArchived": true,
  "isCatchAll": true,
  "mailbox": {
    "name": "string",
    "passwordUpdatedAt": "2024-12-18T07:53:15.340Z",
    "sendingEnabled": true,
    "spamProtection": {
      "active": true,
      "autoDeleteSpam": true,
      "folder": "spam",
      "relocationMinSpamScore": 123
    },
    "storageInBytes": {
      "current": {
        "updatedAt": "2024-12-18T07:53:15.340Z",
        "value": 123
      },
      "limit": 123
    }
  },
  "projectId": "string",
  "receivingDisabled": true,
  "updatedAt": "2024-12-18T07:53:15.340Z"
}

JSON Schema

{
  "properties": {
    "address": {
      "format": "idn-email",
      "type": "string"
    },
    "autoResponder": {
      "properties": {
        "active": {
          "type": "boolean"
        },
        "expiresAt": {
          "format": "date-time",
          "type": "string"
        },
        "message": {
          "type": "string"
        },
        "startsAt": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "active"
      ],
      "type": "object"
    },
    "forwardAddresses": {
      "items": {
        "format": "idn-email",
        "type": "string"
      },
      "type": "array"
    },
    "id": {
      "format": "uuid",
      "type": "string"
    },
    "isArchived": {
      "type": "boolean"
    },
    "isCatchAll": {
      "type": "boolean"
    },
    "mailbox": {
      "properties": {
        "name": {
          "type": "string"
        },
        "passwordUpdatedAt": {
          "format": "date-time",
          "type": "string"
        },
        "sendingEnabled": {
          "type": "boolean"
        },
        "spamProtection": {
          "properties": {
            "active": {
              "type": "boolean"
            },
            "autoDeleteSpam": {
              "type": "boolean"
            },
            "folder": {
              "enum": [
                "spam",
                "inbox"
              ],
              "type": "string"
            },
            "relocationMinSpamScore": {
              "maximum": 10,
              "type": "integer"
            }
          },
          "required": [
            "active",
            "folder",
            "relocationMinSpamScore",
            "autoDeleteSpam"
          ],
          "type": "object"
        },
        "storageInBytes": {
          "properties": {
            "current": {
              "properties": {
                "updatedAt": {
                  "format": "date-time",
                  "type": "string"
                },
                "value": {
                  "type": "number"
                }
              },
              "required": [
                "value",
                "updatedAt"
              ],
              "type": "object"
            },
            "limit": {
              "type": "number"
            }
          },
          "required": [
            "limit",
            "current"
          ],
          "type": "object"
        }
      },
      "required": [
        "name",
        "sendingEnabled",
        "spamProtection",
        "storageInBytes",
        "passwordUpdatedAt"
      ],
      "type": "object"
    },
    "projectId": {
      "type": "string"
    },
    "receivingDisabled": {
      "type": "boolean"
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "receivingDisabled",
    "address",
    "isCatchAll",
    "projectId",
    "forwardAddresses",
    "updatedAt",
    "autoResponder",
    "isArchived"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/mail-addresses/f0f86186-0a5a-45b2-aa33-502777496347

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.getMailAddress({
  "mailAddressId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

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

$request = (new GetMailAddressRequest(
  mailAddressId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->mail()->getMailAddress($request);

var_dump($response->getBody();