Dhairya-007 opened a new pull request, #29538:
URL: https://github.com/apache/camel/pull/29538
`MailConfiguration.ignoreUriScheme` is a boolean about the endpoint URI
scheme, but its description is `ignoreUnsupportedCharset`'s, copied verbatim:
| Option | Description |
| --- | --- |
| `ignoreUnsupportedCharset` | Option to let Camel ignore unsupported
charset in the local JVM when sending mails. If the charset is unsupported,
then charset=XXX … is removed from the content-type, and it relies on the
platform default instead. |
| `ignoreUriScheme` | *identical* |
So the catalog, the component docs table and both DSLs document two options
with the same text, and nothing says what `ignoreUriScheme` does.
What it does, from `MailConfiguration.configure(URI)`:
```java
if (!isIgnoreUriScheme()) {
String scheme = uri.getScheme();
if (scheme != null) {
configureProtocol(scheme);
}
}
```
By default the URI scheme (`imap`, `imaps`, `pop3`, `pop3s`, `smtp`,
`smtps`) sets the protocol; with the option on, a protocol already configured
on the `MailConfiguration` is kept. That is the case
`MailUsingOwnComponentTest` exercises: a configuration with
`configureProtocol("smtp")` and `setIgnoreUriScheme(true)` shared via the
component.
New description:
> Whether to ignore the scheme of the endpoint URI when configuring the mail
protocol. By default the scheme (imap, imaps, pop3, pop3s, smtp or smtps) sets
the protocol used to talk to the mail server. Enable this to keep a protocol
that was already configured on the mail configuration, for example one shared
via the component.
The setter javadoc is the source the generator reads (the `@UriParam` has no
`description`), so it is changed there and propagated to the six component JSON
files, their `camel-catalog` copies (kept byte-identical), the six component
DSL factories and `MailEndpointBuilderFactory`. The DSL javadoc is wrapped with
the generator's algorithm, so a regen should produce no diff; if CI's regen
disagrees I will take its patch.
Doc-only change, no behaviour change.
--
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]
