添加匹配规则 - 邮件收件读邮件API

请求参数

Header 参数

Safe-Key

string

可选

如果配置文件里配置了安全密钥，那么需要传

Body 参数application/json

roleTitle

string

规则名称

必需

roleUseType

string

匹配命中方式

必需

0=发件人包含特定内容，1=主题包含特定内容，2=正文包含特定内容

roleUseContent

string

特定内容

可选

roleRegType

string

匹配内容方式

必需

0=前后截取，1=正则匹配

roleRegText1

string

截取前，变量[n][r]

可选

roleRegText2

string

截取后，变量[n][r]

可选

roleRegContent

string

正则表达式

可选

请使用/代替\

removeNr

string

去除换行符

必需

0=去除，1=不去除

status

string

状态

必需

0=正常，1=禁用

roleDoRun

string

命中后执行

必需

0=无，1=链接访问，2=链接访问(代理)

roleRegText1Add

string

结果前补内容

必需

roleRegText2Add

string

结果后补内容

必需

示例

{
    "roleTitle": "苹果iPhone验证码",
    "roleUseType": "0",
    "roleUseContent": "@id.apple.com",
    "roleRegType": "0",
    "roleRegText1": "请在电子邮件验证页面输入下方验证码：[n][n]",
    "roleRegText2": "[n]",
    "roleRegContent": "",
    "removeNr": "0",
    "status": "0"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://127.0.0.1:8091/email/email/role/add' \
--header 'Safe-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "roleTitle": "苹果iPhone验证码",
    "roleUseType": "0",
    "roleUseContent": "@id.apple.com",
    "roleRegType": "0",
    "roleRegText1": "请在电子邮件验证页面输入下方验证码：[n][n]",
    "roleRegText2": "[n]",
    "roleRegContent": "",
    "removeNr": "0",
    "status": "0"
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

success

boolean

必需

msg

string

必需

data

object

必需

createId

null

必需

createTime

string

必需

updateId

null

必需

updateTime

string

必需

isDelete

integer

必需

id

string

必需

roleTitle

string

必需

roleUseType

string

必需

roleUseContent

string

必需

roleRegType

string

必需

roleRegText1

string

必需

roleRegText2

string

必需

roleRegContent

string

必需

removeNr

string

必需

status

string

必需

timestamp

integer

必需

示例

{
    "code": 200,
    "success": true,
    "msg": "操作成功",
    "data": {
        "createId": null,
        "createTime": "2024-01-20 22:15:44",
        "updateId": null,
        "updateTime": "2024-01-20 22:16:56",
        "isDelete": 0,
        "id": "fe67829b0f404f2ca86548f5239683b2",
        "roleTitle": "苹果iPhone验证码",
        "roleUseType": "0",
        "roleUseContent": "@id.apple.com",
        "roleRegType": "0",
        "roleRegText1": "请在电子邮件验证页面输入下方验证码：[n][n]",
        "roleRegText2": "[n]",
        "roleRegContent": "",
        "removeNr": "0",
        "status": "0"
    },
    "timestamp": 1705760776012
}