版本：Next

Email

Email 数据接收器

描述

将接收到的数据写成附件文件，并发送到一个或多个邮箱地址。

连接器会把每张表的数据缓冲到一个带分隔符的附件文件里（每行一条记录，不含表头），并在 Writer 关闭时为每张表各发送一封邮件。如果某张表没有数据，则不会为该表发送邮件。

支持版本

测试版本:1.5.6(供参考)

主要特性

选项

名称	类型	是否必须	默认值
email_from_address	string	是	-
email_to_address	string	是	-
email_host	string	是	-
email_transport_protocol	string	是	-
email_smtp_auth	boolean	是	-
email_smtp_port	int	否	465
email_authorization_code	string	是	-
email_message_headline	string	是	-
email_message_content	string	是	-
email_attachment_name	string	否	emailsink.csv
email_field_delimiter	string	否	,
multi_table_sink_replica	int	否	1
common-options		否	-

email_from_address [string]

发件人邮箱地址

email_to_address [string]

接收邮件的地址，支持多个邮箱地址，以逗号（,）分隔。

示例：receiver-1@example.com,receiver-2@example.com。

email_host [string]

连接的SMTP服务器地址

email_transport_protocol [string]

发送邮件使用的传输协议，通常为 smtp（或 smtps）。

email_smtp_auth [boolean]

是否启用 SMTP 认证。设为 true 时，连接器会自动开启 SSL，并以 email_from_address 作为用户名、email_authorization_code 作为密码进行认证。设为 false 时，连接器通过普通 SMTP 发送邮件，不进行认证。

email_smtp_port [int]

SMTP 服务器端口。默认值 465 为 SMTPS 端口，需与 email_smtp_auth = true 配合使用。如果使用不带认证的普通 SMTP，请填写与服务匹配的端口（例如 25 或 3025）。

email_authorization_code [string]

当 email_smtp_auth = true 时，用于与 email_from_address 一起对 SMTP 会话进行认证的授权码或密码。可以从邮箱设置中获取（例如 QQ 邮箱、Gmail、163 邮箱等提供的专用密码 / 授权码）。

连接器要求必须配置该项。当 email_smtp_auth = false 时，可以配置为空字符串。

email_message_headline [string]

邮件的标题

email_message_content [string]

邮件消息的正文

email_attachment_name [string]

邮件附件的文件名。默认为 emailsink.csv。连接器会先把数据写到本地这个文件里，再作为附件发送。

email_field_delimiter [string]

附件文件中用于分隔字段的分隔符。默认为逗号 ,。

附件不包含表头。字段会按上游 schema 的顺序写入，null 值会写成空字符串。

multi_table_sink_replica [int]

多表写入时，每张表使用的 Sink Writer 副本数。默认值为 1。

空数据行为

只有上游至少写入一行数据时，Email Sink 才会发送邮件。如果上游表没有数据，则不会发送邮件。

common options

Sink插件常用参数，请参考 Sink常用选项了解详情.

提示

认证与 SSL

当 email_smtp_auth = true 时，连接器会开启 SSL（mail.smtp.ssl.enable）并信任所有 SMTP 主机，因此默认端口 465（SMTPS）适用于 QQ 邮箱、Gmail、163 邮箱等服务商。请使用邮箱的授权码（专用密码）作为 email_authorization_code，而不是账号登录密码。
当 email_smtp_auth = false 时，连接器通过不带 SSL 的普通 SMTP 发送邮件，请选择匹配的普通 SMTP 端口（例如 25 或本地测试服务的 3025）。

示例

发送单表数据到多个收件人

这个示例使用不需要认证的 SMTP 服务，并发送一封收件人列表由 email_to_address 决定的邮件。

env {
  parallelism = 1
  job.mode = "BATCH"
}

source {
  FakeSource {
    tables_configs = [
      {
        row.num = 100
        schema = {
          table = "test.table1"
          columns = [
            {
              name = "id"
              type = "bigint"
            },
            {
              name = "name"
              type = "string"
            },
            {
              name = "age"
              type = "int"
            }
          ]
        }
      }
    ]
  }
}

sink {
  EmailSink {
    email_from_address = "sender@example.com"
    email_to_address = "receiver-1@example.com,receiver-2@example.com"
    email_host = "smtp.example.com"
    email_transport_protocol = "smtp"
    email_smtp_auth = false
    email_smtp_port = 3025
    email_authorization_code = ""
    email_message_headline = "test-title"
    email_message_content = "test-content"
    email_attachment_name = "report.csv"
    email_field_delimiter = "|"
  }
}

发送多表数据

Email sink 支持多表输入。两个上游表会让每个收件人收到两封邮件。

source {
  FakeSource {
    tables_configs = [
      {
        row.num = 100
        schema {
          table = "test.table1"
          fields {
            id = bigint
            name = string
            age = int
          }
        }
      },
      {
        row.num = 100
        schema {
          table = "test.table2"
          fields {
            id = bigint
            name = string
            age = int
          }
        }
      }
    ]
  }
}

sink {
  EmailSink {
    email_from_address = "sender@example.com"
    email_to_address = "receiver-3@example.com,receiver-4@example.com"
    email_host = "smtp.example.com"
    email_transport_protocol = "smtp"
    email_smtp_auth = false
    email_smtp_port = 3025
    email_authorization_code = ""
    email_message_headline = "test-title"
    email_message_content = "test-content"
  }
}

使用 SMTP 认证发送

本示例通过 QQ 邮箱等需要认证的 SMTP 服务器发送邮件。当 email_smtp_auth = true 时，连接器会自动开启 SSL，并使用 email_from_address 和 email_authorization_code 进行认证。请将授权码替换为你在邮箱设置中生成的授权码。

env {
  parallelism = 1
  job.mode = "BATCH"
}

source {
  FakeSource {
    row.num = 100
    schema = {
      fields {
        id = bigint
        name = string
        age = int
      }
    }
  }
}

sink {
  EmailSink {
    email_from_address = "xxxxxxxx@qq.com"
    email_to_address = "xxxxxxxx@qq.com"
    email_host = "smtp.qq.com"
    email_transport_protocol = "smtp"
    email_smtp_auth = true
    email_authorization_code = "your-authorization-code"
    email_message_headline = "test-title"
    email_message_content = "test-content"
  }
}

变更日志

Change Log

Change	Commit	Version
[improve] email connector options (#8983)	https://github.com/apache/seatunnel/commit/7821e824dd	2.3.10
[Improve] restruct connector common options (#8634)	https://github.com/apache/seatunnel/commit/f3499a6eeb	2.3.10
[Improve][Transform] Rename sql transform table name from 'fake' to 'dual' (#8298)	https://github.com/apache/seatunnel/commit/e6169684fb	2.3.9
[Feature][Core] Rename `result_table_name`/`source_table_name` to `plugin_input/plugin_output` (#8072)	https://github.com/apache/seatunnel/commit/c7bbd322db	2.3.9
[Feature][Restapi] Allow metrics information to be associated to logical plan nodes (#7786)	https://github.com/apache/seatunnel/commit/6b7c53d03c	2.3.9
[Improve][Connector-V2]Support multi-table sink feature for email (#7368)	https://github.com/apache/seatunnel/commit/c880b7aa4d	2.3.8
[Improve][Common] Adapt `FILE_OPERATION_FAILED` to `CommonError` (#5928)	https://github.com/apache/seatunnel/commit/b3dc0bbc21	2.3.4
[Feature][Engine] Unify job env parameters (#6003)	https://github.com/apache/seatunnel/commit/2410ab38f0	2.3.4
[Improve][Common] Introduce new error define rule (#5793)	https://github.com/apache/seatunnel/commit/9d1b2582b2	2.3.4
[Improve] Remove use `SeaTunnelSink::getConsumedType` method and mark it as deprecated (#5755)	https://github.com/apache/seatunnel/commit/8de7408100	2.3.4
[Improve][build] Give the maven module a human readable name (#4114)	https://github.com/apache/seatunnel/commit/d7cd601051	2.3.1
[Improve][Project] Code format with spotless plugin. (#4101)	https://github.com/apache/seatunnel/commit/a2ab166561	2.3.1
[Improve][Connector-V2][Email] Unified exception for email connector (#3898)	https://github.com/apache/seatunnel/commit/829261e1a6	2.3.1
[Hotfix][OptionRule] Fix option rule about all connectors (#3592)	https://github.com/apache/seatunnel/commit/226dc6a119	2.3.0
[Connector][Email] Add Email Sink Factory (#3326)	https://github.com/apache/seatunnel/commit/0645d11180	2.3.0
[Improve][all] change Log to @Slf4j (#3001)	https://github.com/apache/seatunnel/commit/6016100f12	2.3.0-beta
[#2606]Dependency management split (#2630)	https://github.com/apache/seatunnel/commit/fc047be69b	2.2.0-beta
[Connector-V2] Add Email sink connector (#2304)	https://github.com/apache/seatunnel/commit/96f2a15e4d	2.2.0-beta

Email

描述​

支持版本​

主要特性​

选项​

email_from_address [string]​

email_to_address [string]​

email_host [string]​

email_transport_protocol [string]​

email_smtp_auth [boolean]​

email_smtp_port [int]​

email_authorization_code [string]​

email_message_headline [string]​

email_message_content [string]​

email_attachment_name [string]​

email_field_delimiter [string]​

multi_table_sink_replica [int]​

空数据行为​

common options​

示例​

发送单表数据到多个收件人​

发送多表数据​

使用 SMTP 认证发送​

变更日志​

描述