Swagger UI

Purelymail API
 0.0.1 
OAS3

This is the Purelymail API specification.

Proprietary
Servers

User

Operations related to users

Creates a new user.

Parameters

No parameters

Request body

{
  "userName": "string",
  "domainName": "string",
  "password": "string",
  "enablePasswordReset": true,
  "recoveryEmail": "string",
  "recoveryEmailDescription": "string",
  "recoveryPhone": "string",
  "recoveryPhoneDescription": "string",
  "enableSearchIndexing": true,
  "sendWelcomeEmail": true
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

Deletes a user.

Parameters

No parameters

Request body

{
  "userName": "string"
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

Lists all users under your account (up to 1000).

Parameters

No parameters

Request body

{}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {
    "users": [
      "string"
    ]
  }
}
No links

Modifies a user.

Parameters

No parameters

Request body

{
  "userName": "string",
  "newUserName": "string",
  "newPassword": "string",
  "enableSearchIndexing": true,
  "enablePasswordReset": true,
  "requireTwoFactorAuthentication": true
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

Retrieves details of a user.

Parameters

No parameters

Request body

{
  "userName": "string"
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {
    "enableSearchIndexing": true,
    "recoveryEnabled": true,
    "requireTwoFactorAuthentication": true,
    "enableSpamFiltering": true,
    "resetMethods": [
      {
        "type": {},
        "target": "string",
        "description": "string",
        "allowMfaReset": true
      }
    ]
  }
}
No links

Creates or updates a password reset method (either phone or email).

Parameters

No parameters

Request body

{
  "userName": "string",
  "existingTarget": "string",
  "type": "string",
  "target": "string",
  "description": "",
  "allowMfaReset": true
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

Deletes a password reset method.

Parameters

No parameters

Request body

{
  "userName": "string",
  "target": "string"
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

Lists all password reset methods for a user.

Parameters

No parameters

Request body

{
  "userName": "string"
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {
    "users": [
      {
        "type": "string",
        "target": "string",
        "description": "string",
        "allowMfaReset": true
      }
    ]
  }
}
No links

Creates a new app password.

Parameters

No parameters

Request body

{
  "userHandle": "string",
  "name": ""
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {
    "appPassword": "string"
  }
}
No links

Deletes an app password.

Parameters

No parameters

Request body

{
  "userName": "string",
  "appPassword": "string"
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

User Password Reset

Operations related to users' password reset

Creates or updates a password reset method (either phone or email).

Parameters

No parameters

Request body

{
  "userName": "string",
  "existingTarget": "string",
  "type": "string",
  "target": "string",
  "description": "",
  "allowMfaReset": true
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

Deletes a password reset method.

Parameters

No parameters

Request body

{
  "userName": "string",
  "target": "string"
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

Lists all password reset methods for a user.

Parameters

No parameters

Request body

{
  "userName": "string"
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {
    "users": [
      {
        "type": "string",
        "target": "string",
        "description": "string",
        "allowMfaReset": true
      }
    ]
  }
}
No links

Routing

Related to mail routing

Routing rule must not have the same user/prefix as any other existing rules for the domain.

Parameters

No parameters

Request body

{
  "domainName": "string",
  "prefix": true,
  "matchUser": "string",
  "targetAddresses": [
    "string"
  ],
  "catchall": false
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

Parameters

No parameters

Request body

{
  "routingRuleId": 0
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

Parameters

No parameters

Request body

{}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {
    "rules": [
      {
        "id": 0,
        "domainName": "string",
        "prefix": true,
        "matchUser": "string",
        "targetAddresses": [
          "string"
        ],
        "catchall": true
      }
    ]
  }
}
No links

Domains

Operations related to domains

Adds a domain, assuming it passes DNS checks.

Parameters

No parameters

Request body

{
  "domainName": "string"
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

Gets the DNS record value of the Purelymail ownership proof record, required to add a domain

Parameters

No parameters

Request body

{}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {
    "code": "string"
  }
}
No links

Lists domains accessible to an account, possibly including shared domains.

Parameters

No parameters

Request body

{
  "includeShared": false
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {
    "domains": [
      {
        "name": "string",
        "allowAccountReset": true,
        "symbolicSubaddressing": true,
        "isShared": true,
        "dnsSummary": {
          "passesMx": true,
          "passesSpf": true,
          "passesDkim": true,
          "passesDmarc": true
        }
      }
    ]
  }
}
No links

Updates settings for an existing owned domain.

Parameters

No parameters

Request body

{
  "name": "string",
  "allowAccountReset": true,
  "symbolicSubaddressing": true,
  "recheckDns": false
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

Deletes a domain, and all dependent settings and users.

Parameters

No parameters

Request body

{
  "name": "string"
}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {}
}
No links

Billing

Operations related to billing and credit

Returns current account credit, as a BigDecimal string with precision 64.

Parameters

No parameters

Request body

{}

Responses

CodeDescriptionLinks
200

Result of operation

Media type
Controls Accept header.
{
  "result": {
    "credit": "string"
  }
}
No links