How to use IBM App Connect with Microsoft Exchange
Microsoft Exchange is a cloud-based service that manages your emails, contacts, and calendars.
- App Connect Enterprise as a Service connector
- Local connector in containers (Continuous Delivery release)
- Local connector in containers (Long Term Support release)
- Local connector in containers (Long Term Support Cycle-2 release)
Supported product and API versions
To find out which product and API versions this connector supports, see Detailed System Requirements on the IBM Support page.
Connecting to Microsoft Exchange
Complete the connection fields that you see in the App Connect Designer page (previously the Catalog page) or flow editor. If necessary, work with your Microsoft Exchange administrator to obtain these values.
- Non-admin user
- Admin user
Microsoft Exchange connection fields:
Authorization method | Connection field | Description | Applicability |
---|---|---|---|
BASIC OAUTH | Access token | The access token generated from the application client ID and client secret. | App Connect in containers and App Connect Enterprise as a Service |
Refresh token | The refresh token generated from the application client ID and client secret. | ||
Client ID | The unique identifier generated after the Microsoft Azure app registration gets mapped to the specific project requests. | ||
Client secret | The application client secret for a project-specific unique application client ID. | ||
OAUTH 2.0 AUTH CODE |
Tip: Authorize connection to Microsoft Exchange by signing
in to your account.
|
App Connect Enterprise as a Service |
To obtain the connection values for Microsoft Exchange, see Obtaining connection values for Microsoft Exchange.
To connect to a Microsoft Exchange endpoint from the App Connect Designer Applications and APIs page for the first time, expand Microsoft Exchange, then click Connect. For more information, see Managing accounts.
Before you use the account that is created in App Connect in a flow, rename the account to something meaningful that helps you to identify it. To rename the account on the Applications and APIs page, select the account, open its options menu (⋮), then click Rename Account.
General considerations
Before you use App Connect Designer with Microsoft Exchange, take note of the following considerations:
- (General consideration) You can see lists of the trigger events and
actions that are available on the Applications and APIs page of the App Connect Designer.
For some applications, the events and actions depend on the environment and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.
- (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.
Events and actions
Microsoft Exchange events
These events are for changes in this application that trigger a flow to start completing the actions in the flow.
Show more configurable events: Events that are shown by default are pre-configured by using optimized connectivity. More items are available after you configure events that can trigger a flow by polling this application for new or updated objects. For more information about configurable events, see Configuring polled events to trigger flows.
Microsoft Exchange actions
Your flow completes these actions on this application.
- Attachments
-
- Create attachment
- Retrieve attachments
- Delete attachment
- Download attachment
- Calendar groups
-
- Create calendar group
- Retrieve calendar groups
- Update calendar group
- Delete calendar group
- Calendars
-
- Create calendar
- Retrieve calendars
- Update calendar
- Delete calendar
- Contact folders
-
- Create contact folder
- Retrieve contact folders
- Update contact folder
- Delete contact folder
- Contacts
-
- Create contact
- Retrieve contacts
- Update contact
- Delete contact
- Conversations
-
- Create conversation
- Retrieve conversations
- Emails
-
- Create draft email
- Move email
- Send email
- Retrieve emails
- Update email
- Delete email
- Send draft email
- Reply to email
- Reply all to email
- Forward email
- Copy email
- Groups
-
- Create group
- Retrieve groups
- Delete group
- Update group
- Mail folders
-
- Create mail folder
- Retrieve mail folders
- Update mail folder
- Delete mail folder
- Organizations
-
- Retrieve organizations
- Users
-
- Retrieve users
Examples
Use templates to quickly create flows for Microsoft Exchange
Learn how to use App Connect templates to quickly create flows that perform actions on Microsoft Exchange. For example, open the Templates gallery, and then search for Microsoft Exchange.