Download OpenAPI specification:Download
Mail ingestion, processing and scripting.
accountId required | string String Id of the account |
[- {
- "account": "testAccount",
- "ruleId": 100345,
- "type": "DeadMans",
- "pingDays": 0,
- "sendDays": 0,
- "pingRecipients": [
- "user@example.com"
], - "sendRecipients": [
- "user@example.com"
], - "pingText": "Your deadmans email will be end in {{days}} days.",
- "sendText": "This is the email that will be sent to recipients"
}
]
accountId required | string String Id of the account |
Create Mail rule
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 |
{- "account": "testAccount",
- "type": "DeadMans",
- "pingDays": 0,
- "sendDays": 0,
- "pingRecipients": [
- "user@example.com"
], - "sendRecipients": [
- "user@example.com"
], - "pingText": "Your deadmans email will be end in {{days}} days.",
- "sendText": "This is the email that will be sent to recipients"
}
ruleId required | string <uuid> Numeric ID of the rule |
accountId required | string String Id of the account |
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 |
{- "account": "testAccount",
- "type": "DeadMans",
- "pingDays": 0,
- "sendDays": 0,
- "pingRecipients": [
- "user@example.com"
], - "sendRecipients": [
- "user@example.com"
], - "pingText": "Your deadmans email will be end in {{days}} days.",
- "sendText": "This is the email that will be sent to recipients"
}
ruleId required | string <uuid> Numeric ID of the rule |
accountId required | string String Id of the account |
{- "account": "testAccount",
- "ruleId": 100345,
- "type": "DeadMans",
- "pingDays": 0,
- "sendDays": 0,
- "pingRecipients": [
- "user@example.com"
], - "sendRecipients": [
- "user@example.com"
], - "pingText": "Your deadmans email will be end in {{days}} days.",
- "sendText": "This is the email that will be sent to recipients"
}
Return the email addresses owned by account
accountId required | string String Id of the account |
[- {
- "emailAddress": "string",
- "rule": "472a7969-d690-4aff-955f-38ab8ac65ab2",
- "ruleDescription": "string"
}
]
Return information on an address
accountId required | string String Id of the account |
address required | string email address |
[- {
- "emailAddress": "string",
- "rule": "472a7969-d690-4aff-955f-38ab8ac65ab2",
- "ruleDescription": "string"
}
]
Set rule for address, or create address connected to rule.
accountId required | string String Id of the account |
address required | string email address |
RuleID to set to address
"string"