mail imap source Mail IMAP Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Receive unread emails from an IMAP mail server, marking them as read once they are received.

The Kamelet generates the following headers:

  • subject / ce-subject: the subject of the incoming mail

  • from / ce-from: the from field of the incoming mail

  • to / ce-to: the to field of the incoming mail

  • cc / ce-cc: the cc field of the incoming mail

Configuration Options

The following table summarizes the configuration options available for the mail-imap-source Kamelet:

Property Name Description Type Default Example

connectionHost *

Connection Host

The IMAP server host

string

"imap.gmail.com"

connectionPort *

Connection Port

The IMAP server port

string

993

password *

Password

The password to access the mail box

string

username *

Username

The username to access the mail box

string

delay

Delay

The delay between fetches in milliseconds

integer

60000

fetchSize

Fetch Size

The number of messages fetched for each poll (-1 for no limits)

integer

10
Fields marked with (*) are mandatory.

Usage

This section summarizes how the mail-imap-source can be used in various contexts.

Knative Source

The mail-imap-source Kamelet can be used as Knative source by binding it to a Knative object.

mail-imap-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: mail-imap-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: mail-imap-source
    properties:
      connectionHost: "imap.gmail.com"
      password: "The Password"
      username: "The Username"
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Make sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the mail-imap-source-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

kubectl apply -f mail-imap-source-binding.yaml

Dependencies

The Kamelet needs the following dependencies:

  • camel:core

  • camel:mail

  • camel:kamelet

Binding to Knative using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind mail-imap-source -p "source.connectionHost=imap.gmail.com" -p "source.password=The Password" -p "source.username=The Username" channel:mychannel

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kafka Source

The mail-imap-source Kamelet can be used as Kafka source by binding it to a Kafka topic.

mail-imap-source-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: mail-imap-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: mail-imap-source
    properties:
      connectionHost: "imap.gmail.com"
      password: "The Password"
      username: "The Username"
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Ensure that you’ve installed Strimzi and created a topic named my-topic in the current namespace. Make also sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the mail-imap-source-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

kubectl apply -f mail-imap-source-binding.yaml

Binding to Kafka using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind mail-imap-source -p "source.connectionHost=imap.gmail.com" -p "source.password=The Password" -p "source.username=The Username" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kamelet source file

Have a look at the following link:

https://github.com/apache/camel-kamelets/blob/main/mail-imap-source.kamelet.yaml

Back to top