SpringCloud/stream-applications
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Link to function catalog docs for config props (#526)

Browse Source 
Prior to this commit, each app documented its available config props
in its README.adoc. Now that the functions have been moved to the
function catalog, these inline docs are replaced w/ a link to the
respective function catalog docs.

See #524
This commit is contained in:
Chris Bono
2024-03-28 10:44:08 -05:00
committed by GitHub
parent 782e21ac1b
commit 7487dc8f61
55 changed files with 114 additions and 1384 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
applications/source/mail-source/README.adoc
View File

@@ -7,15 +7,8 @@ A source application that listens for Emails and emits the message body as a mes
The **$$mail$$** $$source$$ has the following options:
//tag::configuration-properties[]
$$mail.supplier.charset$$:: $$The charset for byte[] mail-to-string transformation.$$ *($$String$$, default: `$$UTF-8$$`)*
$$mail.supplier.delete$$:: $$Set to true to delete email after download.$$ *($$Boolean$$, default: `$$false$$`)*
$$mail.supplier.expression$$:: $$Configure a SpEL expression to select messages.$$ *($$String$$, default: `$$true$$`)*
$$mail.supplier.idle-imap$$:: $$Set to true to use IdleImap Configuration.$$ *($$Boolean$$, default: `$$false$$`)*
$$mail.supplier.java-mail-properties$$:: $$Java Mail properties as a new line delimited string of name-value pairs, e.g. 'foo=bar\n baz=car'.$$ *($$Properties$$, default: `$$<none>$$`)*
$$mail.supplier.mark-as-read$$:: $$Set to true to mark email as read.$$ *($$Boolean$$, default: `$$false$$`)*
$$mail.supplier.url$$:: $$Mail connection URL for connection to Mail server e.g. 'imaps://username:password@imap.server.com:993/Inbox'.$$ *($$URLName$$, default: `$$<none>$$`)*
$$mail.supplier.user-flag$$:: $$The flag to mark messages when the server does not support \Recent.$$ *($$String$$, default: `$$<none>$$`)*
//tag::configuration-properties[link-to-catalog=true]
https://github.com/spring-cloud/spring-functions-catalog/tree/main/supplier/spring-mail-supplier#configuration-options[See Spring Functions Catalog for configuration options].
//end::configuration-properties[]
//end::ref-doc[]