Microsoft Exchange IMAP OAuth2 Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Receive unread emails from an IMAP Microsoft Exchange mail server, marking them as read once they are received. It uses OAuth2 to authenticate IMAP session.

Configuration Options

The following table summarizes the configuration options available for the ms-exchange-online-imap-oauth-source Kamelet:

Property	Name	Description	Type	Default	Example
clientId	Client ID	Required Azure Active Directory Application Client ID.	string
clientSecret	Client Secret	Required The Azure Active Directory Application Client Secret.	string
tenantId	Tenant ID	Required Azure Active Directory Tenant ID.	string
username	Username	Required The username to access the mail box.	string		arthur@mycompany.com//
connectionHost	Connection Host	The IMAP server host.	string	outlook.office365.com
connectionPort	Connection Port	The IMAP server port.	string	993
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

Property

Name

Description

Type

Default

Example

clientId

Client ID

Required Azure Active Directory Application Client ID.

string

clientSecret

Client Secret

Required The Azure Active Directory Application Client Secret.

string

tenantId

Tenant ID

Required Azure Active Directory Tenant ID.

string

username

Username

Required The username to access the mail box.

string

arthur@mycompany.com//

connectionHost

Connection Host

The IMAP server host.

string

outlook.office365.com

connectionPort

Connection Port

The IMAP server port.

string

993

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

Dependencies

At runtime, the ms-exchange-online-imap-oauth-source Kamelet relies upon the presence of the following dependencies:

camel:core
camel:kamelet
camel:mail-microsoft-oauth
camel:mail

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:ms-exchange-online-imap-oauth-source"
      parameters:
        .
        .
        .
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/ms-exchange-online-imap-oauth-source.kamelet.yaml