Get a mail address

GET/v2/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
• archiveobject

  required
  • activeboolean

    required

    shows if the mail-archive is enabled

  • quotainteger (int64)

    required

    maximum available mail-archive storage in bytes

  • usedBytesinteger (int64)

    required

    current mail-archive usage in bytes

• 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
• isBackupInProgressboolean

  required
• isCatchAllboolean

  required
• mailboxobject
  • mailsystemSettingsobject

    required
    • rateLimitIdstring

      required
  • 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
      • valueinteger (int64)

        required
    • limitinteger (int64)

      required
• projectIdstring

  required
• rateLimitChangeRequestobject
  • rateLimitIdstring

    required

    id of the rate limit requested

• receivingDisabledboolean

  required
• updatedAtstring (date-time)

  required

Example

Content-Type: application/json

{
  "address": "email@mittwald.example",
  "archive": {
    "active": true,
    "quota": 123,
    "usedBytes": 123
  },
  "autoResponder": {
    "active": true,
    "expiresAt": "1985-10-26T01:21:00.000Z",
    "message": "string",
    "startsAt": "1985-10-26T01:21:00.000Z"
  },
  "forwardAddresses": [
    "email@mittwald.example"
  ],
  "id": "f0f86186-0a5a-45b2-aa33-502777496347",
  "isArchived": true,
  "isBackupInProgress": true,
  "isCatchAll": true,
  "mailbox": {
    "mailsystemSettings": {
      "rateLimitId": "string"
    },
    "name": "string",
    "passwordUpdatedAt": "1985-10-26T01:21:00.000Z",
    "sendingEnabled": true,
    "spamProtection": {
      "active": true,
      "autoDeleteSpam": true,
      "folder": "spam",
      "relocationMinSpamScore": 123
    },
    "storageInBytes": {
      "current": {
        "updatedAt": "1985-10-26T01:21:00.000Z",
        "value": 123
      },
      "limit": 123
    }
  },
  "projectId": "string",
  "rateLimitChangeRequest": {
    "rateLimitId": "string"
  },
  "receivingDisabled": true,
  "updatedAt": "1985-10-26T01:21:00.000Z"
}

JSON Schema

{
  "properties": {
    "address": {
      "format": "idn-email",
      "type": "string"
    },
    "archive": {
      "properties": {
        "active": {
          "description": "shows if the mail-archive is enabled",
          "type": "boolean"
        },
        "quota": {
          "description": "maximum available mail-archive storage in bytes",
          "format": "int64",
          "type": "integer"
        },
        "usedBytes": {
          "description": "current mail-archive usage in bytes",
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "active",
        "quota",
        "usedBytes"
      ],
      "type": "object"
    },
    "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"
    },
    "isBackupInProgress": {
      "type": "boolean"
    },
    "isCatchAll": {
      "type": "boolean"
    },
    "mailbox": {
      "properties": {
        "mailsystemSettings": {
          "properties": {
            "rateLimitId": {
              "type": "string"
            }
          },
          "required": [
            "rateLimitId"
          ],
          "type": "object"
        },
        "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": {
                  "format": "int64",
                  "type": "integer"
                }
              },
              "required": [
                "value",
                "updatedAt"
              ],
              "type": "object"
            },
            "limit": {
              "format": "int64",
              "type": "integer"
            }
          },
          "required": [
            "limit",
            "current"
          ],
          "type": "object"
        }
      },
      "required": [
        "name",
        "sendingEnabled",
        "spamProtection",
        "storageInBytes",
        "passwordUpdatedAt",
        "mailsystemSettings"
      ],
      "type": "object"
    },
    "projectId": {
      "type": "string"
    },
    "rateLimitChangeRequest": {
      "properties": {
        "rateLimitId": {
          "description": "id of the rate limit requested",
          "type": "string"
        }
      },
      "required": [
        "rateLimitId"
      ],
      "type": "object"
    },
    "receivingDisabled": {
      "type": "boolean"
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "receivingDisabled",
    "address",
    "isCatchAll",
    "projectId",
    "forwardAddresses",
    "updatedAt",
    "autoResponder",
    "isArchived",
    "isBackupInProgress",
    "archive"
  ],
  "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();