mail imap source Mail IMAP Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

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

Required The IMAP server host.

string

imap.gmail.com

connectionPort

Connection Port

Required The IMAP server port.

string

993

password

Password

Required The password to access the mail box.

string

username

Username

Required 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

Dependencies

At runtime, the mail-imap-source Kamelet relies upon the presence of the following dependencies:

  • camel:core

  • camel:mail

  • camel:kamelet

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the mail-imap-source.

Knative source

You can use the mail-imap-source Kamelet as a Knative source by binding it to a Knative object.

mail-imap-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: mail-imap-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: mail-imap-source
    properties:
      connectionHost: imap.gmail.com
      connectionPort: The Connection Port
      password: The Password
      username: The Username
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the mail-imap-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

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

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

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

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka source

You can use the mail-imap-source Kamelet as a Kafka source by binding it to a Kafka topic.

mail-imap-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: mail-imap-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: mail-imap-source
    properties:
      connectionHost: imap.gmail.com
      connectionPort: The Connection Port
      password: The Password
      username: The Username
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the mail-imap-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

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

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

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

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kamelet source file

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

Back to top