Check if an email is from mittwald

POST/actions/detect-phishing-email/

API version

v2

Request method

POST

Operation ID

verification-detect-phishing-email

---

Parses the eml-file of an email to check if it is a phishing mail or a valid email from mittwald. In some cases we can't confirm the validity of an email.

Request

Responses

Format

application/json

Beschreibung

OK

Schema-Dokumentation

• resultstring (one of: IS_MITTWALD, IS_NOT_MITTWALD, COULD_BE_MITTWALD)

  required

Beispiel

Content-Type: application/json

{
  "result": "IS_MITTWALD"
}

JSON Schema

{
  "properties": {
    "result": {
      "enum": [
        "IS_MITTWALD",
        "IS_NOT_MITTWALD",
        "COULD_BE_MITTWALD"
      ],
      "type": "string"
    }
  },
  "required": [
    "result"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -F "emailEml=@some-filename.jpg" \
    https://api.mittwald.de/v2/actions/detect-phishing-email

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.misc.verificationDetectPhishingEmail({});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Misc\VerificationDetectPhishingEmail\VerificationDetectPhishingEmailRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new VerificationDetectPhishingEmailRequest());
$response = $client->misc()->verificationDetectPhishingEmail($request);

var_dump($response->getBody();