-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
df65c66
commit 6cfe988
Showing
12 changed files
with
587 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,158 @@ | ||
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT | ||
|
||
= image:kamelets/mail-sink.svg[] Mail Sink | ||
|
||
*Provided by: "Apache Software Foundation"* | ||
|
||
*Support Level for this Kamelet is: "Preview"* | ||
|
||
Send mails to given SMTP server. | ||
|
||
== Configuration Options | ||
|
||
The following table summarizes the configuration options available for the `mail-sink` Kamelet: | ||
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"] | ||
|=== | ||
| Property| Name| Description| Type| Default| Example | ||
| *connectionHost {empty}* *| Host| The mail server host| string| | `"smtp.gmail.com"` | ||
| *password {empty}* *| Password| The password to access the mail box| string| | | ||
| *username {empty}* *| Username| The username to access the mail box| string| | | ||
| connectionPort| Port| The mail server port| string| `25`| | ||
| from| From| The `from` field of the outgoing mail| string| | | ||
| protocol| Protocol| The mail protocol to use| string| `"smtp"`| | ||
| subject| Subject| The mail subject of the outgoing mail| string| | | ||
| to| To| The `to` field of the outgoing mail| string| | | ||
|=== | ||
|
||
NOTE: Fields marked with an asterisk ({empty}*) are mandatory. | ||
|
||
|
||
== Dependencies | ||
|
||
At runtime, the `mail-sink` Kamelet relies upon the presence of the following dependencies: | ||
|
||
- camel:core | ||
- camel:mail | ||
- camel:kamelet | ||
|
||
== Usage | ||
|
||
This section describes how you can use the `mail-sink`. | ||
|
||
=== Knative Sink | ||
|
||
You can use the `mail-sink` Kamelet as a Knative sink by binding it to a Knative object. | ||
|
||
.mail-sink-binding.yaml | ||
[source,yaml] | ||
---- | ||
apiVersion: camel.apache.org/v1alpha1 | ||
kind: KameletBinding | ||
metadata: | ||
name: mail-sink-binding | ||
spec: | ||
source: | ||
ref: | ||
kind: Channel | ||
apiVersion: messaging.knative.dev/v1 | ||
name: mychannel | ||
sink: | ||
ref: | ||
kind: Kamelet | ||
apiVersion: camel.apache.org/v1alpha1 | ||
name: mail-sink | ||
properties: | ||
connectionHost: "smtp.gmail.com" | ||
password: "The Password" | ||
username: "The Username" | ||
---- | ||
|
||
==== *Prerequisite* | ||
|
||
You have xref:{camel-k-version}@camel-k::installation/installation.adoc[Camel K installed] on the cluster. | ||
|
||
==== *Procedure for using the cluster CLI* | ||
|
||
. Save the `mail-sink-binding.yaml` file to your local drive, and then edit it as needed for your configuration. | ||
|
||
. Run the sink by using the following command: | ||
+ | ||
[source,shell] | ||
---- | ||
kubectl apply -f mail-sink-binding.yaml | ||
---- | ||
|
||
==== *Procedure for using the Kamel CLI* | ||
|
||
Configure and run the sink by using the following command: | ||
|
||
[source,shell] | ||
---- | ||
kamel bind channel:mychannel mail-sink -p "sink.connectionHost=smtp.gmail.com" -p "sink.password=The Password" -p "sink.username=The Username" | ||
---- | ||
|
||
This command creates the KameletBinding in the current namespace on the cluster. | ||
|
||
=== Kafka Sink | ||
|
||
You can use the `mail-sink` Kamelet as a Kafka sink by binding it to a Kafka topic. | ||
|
||
.mail-sink-binding.yaml | ||
[source,yaml] | ||
---- | ||
apiVersion: camel.apache.org/v1alpha1 | ||
kind: KameletBinding | ||
metadata: | ||
name: mail-sink-binding | ||
spec: | ||
source: | ||
ref: | ||
kind: KafkaTopic | ||
apiVersion: kafka.strimzi.io/v1beta1 | ||
name: my-topic | ||
sink: | ||
ref: | ||
kind: Kamelet | ||
apiVersion: camel.apache.org/v1alpha1 | ||
name: mail-sink | ||
properties: | ||
connectionHost: "smtp.gmail.com" | ||
password: "The Password" | ||
username: "The Username" | ||
---- | ||
|
||
==== *Prerequisites* | ||
|
||
* You've installed https://strimzi.io/[Strimzi]. | ||
* You've created a topic named `my-topic` in the current namespace. | ||
* You have xref:{camel-k-version}@camel-k::installation/installation.adoc[Camel K installed] on the cluster. | ||
|
||
==== *Procedure for using the cluster CLI* | ||
|
||
. Save the `mail-sink-binding.yaml` file to your local drive, and then edit it as needed for your configuration. | ||
|
||
. Run the sink by using the following command: | ||
+ | ||
[source,shell] | ||
---- | ||
kubectl apply -f mail-sink-binding.yaml | ||
---- | ||
|
||
==== *Procedure for using the Kamel CLI* | ||
|
||
Configure and run the sink by using the following command: | ||
|
||
[source,shell] | ||
---- | ||
kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic mail-sink -p "sink.connectionHost=smtp.gmail.com" -p "sink.password=The Password" -p "sink.username=The Username" | ||
---- | ||
|
||
This command creates the KameletBinding in the current namespace on the cluster. | ||
|
||
== Kamelet source file | ||
|
||
https://github.com/apache/camel-kamelets/blob/main/kamelets/mail-sink.kamelet.yaml | ||
|
||
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# --------------------------------------------------------------------------- | ||
# Licensed to the Apache Software Foundation (ASF) under one or more | ||
# contributor license agreements. See the NOTICE file distributed with | ||
# this work for additional information regarding copyright ownership. | ||
# The ASF licenses this file to You under the Apache License, Version 2.0 | ||
# (the "License"); you may not use this file except in compliance with | ||
# the License. You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
# --------------------------------------------------------------------------- | ||
apiVersion: camel.apache.org/v1alpha1 | ||
kind: Kamelet | ||
metadata: | ||
name: mail-sink | ||
annotations: | ||
camel.apache.org/kamelet.support.level: "Preview" | ||
camel.apache.org/catalog.version: "main-SNAPSHOT" | ||
camel.apache.org/kamelet.icon: "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjxzdmcKICAgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIgogICB4bWxuczpjYz0iaHR0cDovL2NyZWF0aXZlY29tbW9ucy5vcmcvbnMjIgogICB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiCiAgIHhtbG5zOnN2Zz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiAgIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIKICAgeG1sbnM6c29kaXBvZGk9Imh0dHA6Ly9zb2RpcG9kaS5zb3VyY2Vmb3JnZS5uZXQvRFREL3NvZGlwb2RpLTAuZHRkIgogICB4bWxuczppbmtzY2FwZT0iaHR0cDovL3d3dy5pbmtzY2FwZS5vcmcvbmFtZXNwYWNlcy9pbmtzY2FwZSIKICAgdmlld0JveD0iMCAwIDE2LjIwMDAwMSAxMi4yIgogICB2ZXJzaW9uPSIxLjEiCiAgIGlkPSJzdmc1IgogICBzb2RpcG9kaTpkb2NuYW1lPSJCcmVlemVpY29ucy1wbGFjZXMtMTYtZm9sZGVyLW1haWwuc3ZnIgogICB3aWR0aD0iMTYuMjAwMDAxIgogICBoZWlnaHQ9IjEyLjIiCiAgIGlua3NjYXBlOnZlcnNpb249IjEuMC4yIChlODZjODcwODc5LCAyMDIxLTAxLTE1KSI+CiAgPG1ldGFkYXRhCiAgICAgaWQ9Im1ldGFkYXRhOSI+CiAgICA8cmRmOlJERj4KICAgICAgPGNjOldvcmsKICAgICAgICAgcmRmOmFib3V0PSIiPgogICAgICAgIDxkYzpmb3JtYXQ+aW1hZ2Uvc3ZnK3htbDwvZGM6Zm9ybWF0PgogICAgICAgIDxkYzp0eXBlCiAgICAgICAgICAgcmRmOnJlc291cmNlPSJodHRwOi8vcHVybC5vcmcvZGMvZGNtaXR5cGUvU3RpbGxJbWFnZSIgLz4KICAgICAgICA8ZGM6dGl0bGU+PC9kYzp0aXRsZT4KICAgICAgPC9jYzpXb3JrPgogICAgPC9yZGY6UkRGPgogIDwvbWV0YWRhdGE+CiAgPHNvZGlwb2RpOm5hbWVkdmlldwogICAgIHBhZ2Vjb2xvcj0iI2ZmZmZmZiIKICAgICBib3JkZXJjb2xvcj0iIzY2NjY2NiIKICAgICBib3JkZXJvcGFjaXR5PSIxIgogICAgIG9iamVjdHRvbGVyYW5jZT0iMTAiCiAgICAgZ3JpZHRvbGVyYW5jZT0iMTAiCiAgICAgZ3VpZGV0b2xlcmFuY2U9IjEwIgogICAgIGlua3NjYXBlOnBhZ2VvcGFjaXR5PSIwIgogICAgIGlua3NjYXBlOnBhZ2VzaGFkb3c9IjIiCiAgICAgaW5rc2NhcGU6d2luZG93LXdpZHRoPSIxOTIwIgogICAgIGlua3NjYXBlOndpbmRvdy1oZWlnaHQ9IjEwMTYiCiAgICAgaWQ9Im5hbWVkdmlldzciCiAgICAgc2hvd2dyaWQ9ImZhbHNlIgogICAgIGZpdC1tYXJnaW4tdG9wPSIwLjEiCiAgICAgZml0LW1hcmdpbi1yaWdodD0iMC4xIgogICAgIGZpdC1tYXJnaW4tbGVmdD0iMC4xIgogICAgIGZpdC1tYXJnaW4tYm90dG9tPSIwLjEiCiAgICAgaW5rc2NhcGU6em9vbT0iNTMuNSIKICAgICBpbmtzY2FwZTpjeD0iOC4xIgogICAgIGlua3NjYXBlOmN5PSIzLjEwOTM0NTgiCiAgICAgaW5rc2NhcGU6d2luZG93LXg9IjAiCiAgICAgaW5rc2NhcGU6d2luZG93LXk9IjI3IgogICAgIGlua3NjYXBlOndpbmRvdy1tYXhpbWl6ZWQ9IjEiCiAgICAgaW5rc2NhcGU6Y3VycmVudC1sYXllcj0ic3ZnNSIgLz4KICA8ZGVmcwogICAgIGlkPSJkZWZzMzA1MSI+CiAgICA8c3R5bGUKICAgICAgIHR5cGU9InRleHQvY3NzIgogICAgICAgaWQ9ImN1cnJlbnQtY29sb3Itc2NoZW1lIj4KICAgICAgLkNvbG9yU2NoZW1lLVRleHQgewogICAgICAgIGNvbG9yOiM0ZDRkNGQ7CiAgICAgIH0KICAgICAgPC9zdHlsZT4KICA8L2RlZnM+CiAgPHBhdGgKICAgICBzdHlsZT0iZmlsbDpjdXJyZW50Q29sb3I7ZmlsbC1vcGFjaXR5OjE7c3Ryb2tlOm5vbmUiCiAgICAgZD0ibSAwLjEsMC4xIHYgMTIgaCAxNiB2IC0xMiB6IG0gMS40MTQwNjI1LDEgSCAxNC42ODU5MzggTCA4LjEsNy42ODU5Mzc1IFogTSAxLjEsMi4xIGwgNCw0IC00LDQgeiBtIDE0LDAgdiA4IGwgLTQsLTQgeiBNIDUuODA3MDMxMiw2LjgwNzAzMTIgOC4xLDkuMSAxMC4zOTI5NjksNi44MDcwMzEyIDE0LjY4NTkzOCwxMS4xIEggMS41MTQwNjI1IFoiCiAgICAgaWQ9InJlY3Q0MTQ0IgogICAgIGNsYXNzPSJDb2xvclNjaGVtZS1UZXh0IiAvPgo8L3N2Zz4K" | ||
camel.apache.org/provider: "Apache Software Foundation" | ||
camel.apache.org/kamelet.group: "Mail" | ||
labels: | ||
camel.apache.org/kamelet.type: "sink" | ||
spec: | ||
definition: | ||
title: "Mail Sink" | ||
description: "Send mails to given SMTP server." | ||
required: | ||
- connectionHost | ||
- username | ||
- password | ||
type: object | ||
properties: | ||
protocol: | ||
description: The mail protocol to use | ||
default: smtp | ||
title: Protocol | ||
type: string | ||
connectionHost: | ||
description: The mail server host | ||
example: smtp.gmail.com | ||
title: Host | ||
type: string | ||
connectionPort: | ||
description: The mail server port | ||
title: Port | ||
default: 25 | ||
type: string | ||
username: | ||
title: Username | ||
description: The username to access the mail box | ||
type: string | ||
x-descriptors: | ||
- urn:camel:group:credentials | ||
password: | ||
title: Password | ||
description: The password to access the mail box | ||
type: string | ||
format: password | ||
x-descriptors: | ||
- urn:alm:descriptor:com.tectonic.ui:password | ||
- urn:camel:group:credentials | ||
from: | ||
description: The `from` field of the outgoing mail | ||
title: From | ||
type: string | ||
to: | ||
description: The `to` field of the outgoing mail | ||
title: To | ||
type: string | ||
subject: | ||
description: The mail subject of the outgoing mail | ||
title: Subject | ||
type: string | ||
dependencies: | ||
- "camel:core" | ||
- "camel:mail" | ||
- "camel:kamelet" | ||
flow: | ||
from: | ||
uri: "kamelet:source" | ||
steps: | ||
- set-header: | ||
name: "Subject" | ||
simple: "${header.ce-subject}" | ||
- set-header: | ||
name: "From" | ||
simple: "${header.ce-from}" | ||
- set-header: | ||
name: "To" | ||
simple: "${header.ce-to}" | ||
- set-header: | ||
name: "Cc" | ||
simple: "${header.ce-cc}" | ||
- remove-headers: | ||
pattern: "ce-*" | ||
- to: '{{protocol}}://{{host}}:{{port}}?subject={{subject}}&from={{from}}&to={{to}}&username={{username}}&password={{password}}' |
Oops, something went wrong.