README

ontavio 邮件服务连接器的文档

待办事项 和计划功能

设置连接器

1. 为项目创建 JWT 令牌

   • 使用 loginAsUser() 函数或手动获取 JWT

2. 使用以下方式创建新的 Connector()：

   • $endpoint -> 您的数据库 URL
   • $auth -> 用于验证用户的 JWT 令牌
   • 可以指定额外的 参数

3. 使用 函数 下的函数进行 CRUD 操作

   • 对于边缘情况，使用 executeQuery() 函数使用您自己的查询

创建连接器对象

构造函数参数

• $endpoint

  • 将端点设置为字符串。

• $auth

  • 插入用于连接端点的 JWT。

• $unSpamSubject

  • 启用“主题”字段格式化，使电子邮件不太可能被标记为垃圾邮件。

• $generateTextFromHTML

  • 使用“html”字段的内容填充“text”字段。

函数

注意：如果函数成功完成，则返回数据，如果失败则返回 null

• setEndpoint(string $newEndpoint)

  • 覆盖端点字符串

• setAuth(string $newAuth)

  • 覆盖 JWT 授权字符串

• loginAsUser(string $endpoint, string $user, string $password)

  • 在提供有效端点、用户和密码时返回 JWT 令牌
  • 仅用于创建初始 JWT 并保存

• executeQuery(string $endpoint, string $query, string $auth)

  • 使用 auth 向端点提交查询
  • 返回查询结果

• removeAllHtml($text, array $replaceProjectSpecific)

  • 移除所有 HTML 标签和数组中的额外字符串

• create(Email $email)

  • 将电子邮件发送到指定的端点
  • 返回创建的电子邮件 ID

• read(string $emailEId)

  • 根据 $emailEId 返回电子邮件

• readStatus(string $emailEId)

  • 返回“已发送”、“拒绝”和“状态”字段

• getEmailId(string $emailEId)

  • 通过搜索电子邮件 EId 返回 emailId
  • 主要用于特定查询

• update(Email $email)

  • 更新提供的整个电子邮件
  • eId 识别要更新的电子邮件
  • 在成功时返回更新邮件的 eId

• delete(string $emailEId)

  • 根据 eId 删除电子邮件
  • 返回 eId 和 id

电子邮件类

电子邮件类包含所有参数的获取器和设置器

Attachment $attachments -> use Attachment Class
bool    $attachDataUrls
array   $bcc
array   $cc
        $delivery //Datetimefomat in DB -> "Y-m-d\TH:i:s.v\Z"
string  $eId
string  $html
string  $htmlTemplate
string  $messageId
        $priority // enum LOW/NORMAL/HIGH
string  $project
string  $replyTo
string  $sender
bool    $single
        $stack 
string  $subject
string  $templateData
string  $text
string  $textTemplate
array   $to