DanielCarter-stack opened a new pull request, #11683:
URL: https://github.com/apache/seatunnel/pull/11683
## Purpose of this PR
The Email sink documentation was thin in a few places that affect how users
configure SMTP authentication and SSL. This PR clarifies those areas based on
the connector code (`EmailSinkWriter`) and the connector e2e examples, and adds
a missing authenticated-SMTP example.
## Changes
- **Description**: Explain that the connector buffers each table's rows into
a delimited attachment file (one row per line, no header row) and sends one
email per table when the writer closes; no email is sent for an empty table.
- **Options**: Clarify the descriptions of `email_transport_protocol`,
`email_smtp_auth`, `email_smtp_port`, and `email_authorization_code`:
- When `email_smtp_auth = true`, the connector enables SSL automatically
(`mail.smtp.ssl.enable`) and authenticates with `email_from_address` (username)
+ `email_authorization_code` (password).
- The default port `465` is the SMTPS port and is used together with
`email_smtp_auth = true`; for plain SMTP without auth, a matching port (e.g.
`25` or `3025`) should be used.
- **Tip block**: Add an "Authentication and SSL" tip summarizing the
auth/no-auth port and credential behavior (including using the mailbox
authorization code rather than the login password).
- **Example**: Add a "Send with SMTP authentication" example (e.g. QQ Mail)
using `email_smtp_auth = true` with an authorization code.
- **Feature list consistency**: Add `timer flush` (unchecked) to the EN
feature list so it matches the ZH doc.
## Notes
- Both `docs/en/connectors/sink/Email.md` and
`docs/zh/connectors/sink/Email.md` are updated and kept consistent.
- Documentation only; no code or version numbers were changed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
