Cloudmersive Email API

openapi: 3.2.0
info:
  version: v1
  title: validateapi Email API
  description: The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.
servers:
- url: http://localhost
tags:
- name: Email
paths:
  /validate/email/address/syntaxOnly:
    post:
      tags:
      - Email
      summary: Validate email adddress for syntactic correctness only
      description: Validate whether a given email address is syntactically correct via a limited local-only check. Use the address/full API to do a full validation.
      operationId: Email_Post
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressVerifySyntaxOnlyResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AddressVerifySyntaxOnlyResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/AddressVerifySyntaxOnlyResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/AddressVerifySyntaxOnlyResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              type: string
          text/json:
            schema:
              type: string
        description: Email address to validate, e.g. "support@cloudmersive.com".    The input is a string so be sure to enclose it in double-quotes.
        required: true
  /validate/email/address/servers:
    post:
      tags:
      - Email
      summary: Partially check whether an email address is valid
      description: Validate an email address by identifying whether its parent domain has email servers defined. This call is less limited than syntaxOnly but not as comprehensive as address/full.
      operationId: Email_AddressGetServers
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressGetServersResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/AddressGetServersResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/AddressGetServersResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/AddressGetServersResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              type: string
          text/json:
            schema:
              type: string
        description: Email address to validate, e.g. "support@cloudmersive.com".    The input is a string so be sure to enclose it in double-quotes.
        required: true
  /validate/email/address/full:
    post:
      tags:
      - Email
      summary: Fully validate an email address
      description: Performs a full validation of the email address. Checks for syntactic correctness, identifies the mail server in question if any, and then contacts the email server to validate the existence of the account - without sending any emails.
      operationId: Email_FullValidation
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FullEmailValidationResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FullEmailValidationResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/FullEmailValidationResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/FullEmailValidationResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          application/json:
            schema:
              type: string
          text/json:
            schema:
              type: string
        description: Email address to validate, e.g. "support@cloudmersive.com".    The input is a string so be sure to enclose it in double-quotes.
        required: true
components:
  schemas:
    FullEmailValidationResponse:
      description: Full email addresss validation result
      type: object
      properties:
        ValidAddress:
          description: True if the email address is valid overall, false otherwise
          type: boolean
        MailServerUsedForValidation:
          description: Email server connected to for verification
          type: string
        Valid_Syntax:
          description: True if the syntax of the email address is valid, false otherwise.  This is one component of ValidAddress, but not the only one.
          type: boolean
        Valid_Domain:
          description: True if the domain name of the email address is valid, false otherwise.  This is one component of ValidAddress, but not the only one.
          type: boolean
        Valid_SMTP:
          description: True if the email address was verified by the remote server, false otherwise.  This is one component of ValidAddress, but not the only one.
          type: boolean
        IsCatchallDomain:
          description: True if the domain is a catch-all domain name, false otherwise.  Catch-all domain names, while rare, always accept inbound email to ensure they do not lose any potentially useful emails.  Catch-all domain names can occassionally be configured to first accept and store all inbound email, but then later send a bounce email back to the sender after a delayed period of time.
          type: boolean
        Domain:
          description: Domain name of the email address
          type: string
        IsFreeEmailProvider:
          description: True if the email domain name is a free provider (typically a free to sign up web email provider for consumers / personal use), false otherwise.
          type: boolean
        IsDisposable:
          description: True if the email address is a disposable email address, false otherwise; these disposable providers are not typically used to receive email and so will have a low likelihood of opening mail sent there.
          type: boolean
    AddressVerifySyntaxOnlyResponse:
      description: Syntactic validity of email address
      type: object
      properties:
        ValidAddress:
          description: True if the email address is syntactically valid, false if it is not
          type: boolean
        Domain:
          description: Domain name of the email address
          type: string
        IsFreeEmailProvider:
          description: True if the email domain name is a free provider (typically a free to sign up web email provider for consumers / personal use), false otherwise.
          type: boolean
        IsDisposable:
          description: True if the email address is a disposable email address, false otherwise; these disposable providers are not typically used to receive email and so will have a low likelihood of opening mail sent there.
          type: boolean
    AddressGetServersResponse:
      description: Result of a partial email address validation
      type: object
      properties:
        Success:
          description: True if partial address validation was successufl, false otherwise
          type: boolean
        Servers:
          description: Email servers for this email address
          type: array
          items:
            type: string
  securitySchemes:
    Apikey:
      type: apiKey
      description: API Key Authentication
      name: Apikey
      in: header
x-provenance:
  method: harvested
  publisher: Cloudmersive
  source: https://api.cloudmersive.com/validate/docs/v1/swagger
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)