API docs by Redocly

MailPlusPlus (1.0.0)

Download OpenAPI specification:Download

Mail ingestion, processing and scripting.

rules

Returns a list of mail rules for the logged in account

Authorizations:
basicAuth
path Parameters
accountId
required
string

String Id of the account

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new Rule

Authorizations:
basicAuth
path Parameters
accountId
required
string

String Id of the account

Request Body schema: application/json

Create Mail rule

One of
account
string [ 1 .. 32 ] characters
type
required
string [ 1 .. 32 ] characters
pingDays
number <int32>

number of days before ping email is sent.

sendDays
number <int32>

number of days until the deadman's email is sent

pingRecipients
Array of strings <email>

Recipients of ping email

sendRecipients
Array of strings <email>

Recipients of deadman's email

pingText
string

template to send for ping message

sendText
string <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "account": "testAccount",
  • "type": "DeadMans",
  • "pingDays": 0,
  • "sendDays": 0,
  • "pingRecipients": [
    ],
  • "sendRecipients": [
    ],
  • "pingText": "Your deadmans email will be end in {{days}} days.",
  • "sendText": "This is the email that will be sent to recipients"
}

Update the specified rule

Authorizations:
basicAuth
path Parameters
ruleId
required
string <uuid>

Numeric ID of the rule

accountId
required
string

String Id of the account

Request Body schema: application/json
One of
account
string [ 1 .. 32 ] characters
type
required
string [ 1 .. 32 ] characters
pingDays
number <int32>

number of days before ping email is sent.

sendDays
number <int32>

number of days until the deadman's email is sent

pingRecipients
Array of strings <email>

Recipients of ping email

sendRecipients
Array of strings <email>

Recipients of deadman's email

pingText
string

template to send for ping message

sendText
string <= 1024 characters

Responses

Request samples

Content type
application/json
Example
{
  • "account": "testAccount",
  • "type": "DeadMans",
  • "pingDays": 0,
  • "sendDays": 0,
  • "pingRecipients": [
    ],
  • "sendRecipients": [
    ],
  • "pingText": "Your deadmans email will be end in {{days}} days.",
  • "sendText": "This is the email that will be sent to recipients"
}

Get the specified rule

Authorizations:
basicAuth
path Parameters
ruleId
required
string <uuid>

Numeric ID of the rule

accountId
required
string

String Id of the account

Responses

Response samples

Content type
application/json
Example
{
  • "account": "testAccount",
  • "ruleId": 100345,
  • "type": "DeadMans",
  • "pingDays": 0,
  • "sendDays": 0,
  • "pingRecipients": [
    ],
  • "sendRecipients": [
    ],
  • "pingText": "Your deadmans email will be end in {{days}} days.",
  • "sendText": "This is the email that will be sent to recipients"
}

Get the specified rule

Authorizations:
basicAuth
path Parameters
ruleId
required
string <uuid>

Numeric ID of the rule

accountId
required
string

String Id of the account

Responses

addresses

getAddresses

Return the email addresses owned by account

Authorizations:
basicAuth
path Parameters
accountId
required
string

String Id of the account

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getAddress

Return information on an address

Authorizations:
basicAuth
path Parameters
accountId
required
string

String Id of the account

address
required
string

email address

Responses

Response samples

Content type
application/json
[
  • {
    }
]

updateAddress

Set rule for address, or create address connected to rule.

Authorizations:
basicAuth
path Parameters
accountId
required
string

String Id of the account

address
required
string

email address

Request Body schema: application/json

RuleID to set to address

string <UUID>

Responses

Request samples

Content type
application/json
"string"

deleteAddress

delete this email address

Authorizations:
basicAuth
path Parameters
accountId
required
string

String Id of the account

address
required
string

email address

Responses