docs/modules/ROOT/pages/mail-imap-source.adoc

// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT
= image:kamelets/mail-imap-source.svg[] Mail IMAP Source

*Provided by: "Apache Software Foundation"*

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

== Configuration Options

The following table summarizes the configuration options available for the `mail-imap-source` Kamelet:
[width="100%",cols="2,^2,3,^2,^2,^3",options="header"]
|===
| Property| Name| Description| Type| Default| Example
| *host {empty}* *| Host| The IMAP server host| string| | `"imap.gmail.com"`
| *password {empty}* *| Password| The password to access the mail box| string| | 
| *port {empty}* *| Port| The IMAP server port| string| `993`| 
| *username {empty}* *| 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`| 
|===

NOTE: Fields marked with ({empty}*) 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
[source,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:
      host: "imap.gmail.com"
      password: "The Password"
      username: "The Username"
  sink:
    ref:
      kind: InMemoryChannel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

----

Make sure you have xref:latest@camel-k::installation/installation.adoc[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:

[source,shell]
----
kubectl apply -f mail-imap-source-binding.yaml
----
// THIS FILE IS AUTOMATICALLY GENERATED: DO NOT EDIT