Microsoft Outlook 365 Connector 1.0 Reference

Configurations


Outlook365 Config

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection types for this configuration.

x

Name

String

ID used to reference this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Read Timeout

Number

Specifies the amount of time in milliseconds that the consumer waits for a response before it times out.

60

Read Timeout Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

SECONDS

Connection Types

OAuth v2.0 Authorization Code

The OAuth 2.0 authorization code grant connection type is used in apps that are installed on a device to gain access to protected resources.

Parameters
Name Type Description Default Value Required

Proxy configuration

Configures a proxy for outbound connections.

Response Type

String

Specifies the method to use to send the resulting token back to your app. This must be query.

query

TLS configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Consumer Key

String

OAuth consumer key, as registered with the service provider.

x

Consumer Secret

String

OAuth consumer secret, as registered with the service provider.

x

Authorization Url

String

URL of the service provider’s authorization endpoint.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/authorize

Access Token Url

String

URL of the service provider’s access token endpoint.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

Resource Owner Id

String

Resource owner ID to use with the authorization code grant type.

Before

String

Name of the flow to execute immediately before starting the OAuth dance.

After

String

Name of the flow to execute immediately after receiving an access token.

Listener Config

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

OAuth v2.0 Client Credentials

The OAuth 2.0 client credentials grant gets access to web-hosted resources by using the identity of the application.

Parameters
Name Type Description Default Value Required

Proxy configuration

Configures a proxy for outbound connections.

TLS configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Client Id

String

OAuth client ID, as registered with the service provider.

x

Client Secret

String

OAuth client secret, as registered with the service provider.

x

Token Url

String

Service provider’s token endpoint URL.

https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

Operations

Accept Event

<outlook365:accept-event>

Accepts the specified event from a user’s calendar.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Event Id

String

ID of the event that performs the action.

x

Accept Event Properties

Object

Accepts information for the event.

Calendar Id

String

ID of the calendar that holds the event.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Add Event Attachment

<outlook365:add-event-attachment>

Adds an attachment to an event. This operation limits the size of the attachment you can add to 3 MB.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Event Id

String

ID of the event that contains the added attachment.

x

Attachment For Event

Any

Attachment added to the event.

#[payload]

Calendar Id

String

ID of the calendar that holds the event.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Add Message Attachment

<outlook365:add-message-attachment>

Adds an attachment to a message. This operation limits the size of the attachment you can add to 3 MB.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

ID of the message that contains the added attachment.

x

Mail Folder Id

String

ID of the mail folder that contains the message.

Attachment For Message

Any

Attachment added to the message.

#[payload]

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Cancel Event

<outlook365:cancel-event>

Cancels the specified event from a user’s calendar.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Event Id

String

ID of the event that performs the action.

x

Comment

String

Reason for cancelling the event.

Calendar Id

String

ID of the calendar that holds the event.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Copy Message

<outlook365:copy-message>

Copies a message to a folder.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

ID of the previously created message entity.

x

Destination Id

String

ID of the destination folder.

x

Mail Folder Id

String

ID of the mail folder that holds the message.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Create Event

<outlook365:create-event>

Creates an event in a user’s default calendar or in a specified calendar.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Event

Object

Event to create.

#[payload]

Outlook Time Zone

String

Time zone for the start and end times in the response.

Calendar Id

String

ID of the calendar that holds the event.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Create Message

<outlook365:create-message>

Creates a draft of a new message in either JSON or MIME format.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message

Any

Message to create.

#[payload]

Request Body Content Format

Enumeration, one of:

  • APPLICATION_JSON

  • MIME

Content type for the request payload.

APPLICATION_JSON

Mail Folder Id

String

ID of the mail folder that creates the message.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Create Reply All To Message

<outlook365:create-reply-all-to-message>

Creates a draft to reply to the sender and all the recipients of the specified message in either JSON or MIME format.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

ID of the message that replies to all.

x

Mail Folder Id

String

ID of the mail folder that holds the message.

Request Body Content Format

Enumeration, one of:

  • APPLICATION_JSON

  • MIME

Content type for the request payload.

APPLICATION_JSON

Reply

Any

Reply all message.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Create Reply To Message

<outlook365:create-reply-to-message>

Creates a draft of the reply to the specified message in either JSON or MIME format.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

ID of the reply message.

x

Mail Folder Id

String

ID of the mail folder that holds the message.

Request Body Content Format

Enumeration, one of:

  • APPLICATION_JSON

  • MIME

Content type for the request payload.

APPLICATION_JSON

Reply

Any

Reply message.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Decline Event

<outlook365:decline-event>

Declines the specified event from a user’s calendar.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Event Id

String

ID of the event that performs the action.

x

Decline Event Properties

Object

Declines information for the event.

Calendar Id

String

ID of the calendar that holds the event.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Delete Event

<outlook365:delete-event>

Removes the specified event from the calendar that contains the event.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Event Id

String

ID of the event that performs the action.

x

Calendar Id

String

ID of the calendar that holds the event.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Delete Event Attachment

<outlook365:delete-event-attachment>

Deletes an attachment from an event.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Event Id

String

ID of the event that performs the action.

x

Attachment Id

String

ID of the attachment to delete.

x

Calendar Id

String

ID of the calendar that holds the event.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Delete Message

<outlook365:delete-message>

Deletes a message from the specified user’s mailbox.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

ID of the message to delete.

x

Mail Folder Id

String

ID of the mail folder that holds the message.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Delete Message Attachment

<outlook365:delete-message-attachment>

Deletes an attachment from a message.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

ID of the message that performs the action.

x

Attachment Id

String

ID of the attachment to delete.

x

Mail Folder Id

String

Mail folder that holds the message.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Forward Event

<outlook365:forward-event>

Enables the organizer or attendee of a meeting event to forward the meeting request to a new recipient.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Event Id

String

ID of the event that performs the action.

x

Forward Event Properties

Object

Forward information for the event.

#[payload]

Calendar Id

String

ID of the calendar that holds the event.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Get Event

<outlook365:get-event>

Gets the properties and relationships of the specified event object. Currently, this operation returns event bodies in HTML only.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Event Id

String

ID of the event that performs the action.

x

O Data Query Params

Additional query parameters or filters.

Outlook Time Zone

String

Time zone for the start and end times in the response.

Outlook Body Content Type

Enumeration, one of:

  • TEXT

  • HTML

Content type of the event body returned.

HTML

Calendar Id

String

ID of the calendar that holds the event.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Get Event Attachment

<outlook365:get-event-attachment>

Reads the properties and relationships of an attachment that is attached to an event. You can append the path segment /$value to get the raw contents of a file or item attachment.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Event Id

String

ID of the event that retrieves the attachment.

x

Attachment Id

String

ID of the attachment retrieved from the event.

x

O Data Query Params

Additional query parameters or filters.

Calendar Id

String

ID of the calendar that holds the event.

Get Raw Content

Boolean

Indicates whether to get the raw content of the attachment or not.

false

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Get Message

<outlook365:get-message>

Retrieves the properties and relationships of a message object.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

ID of the retrieved message.

x

Mail Folder Id

String

ID of the mail folder that holds the message.

Body Content Type

Enumeration, one of:

  • TEXT

  • HTML

The format of the body and uniqueBody properties to return.

HTML

O Data Query Params

Additional query parameters or filters.

Get MIME Content

Boolean

Flag that indicates whether to return the MIME content of the message or not.

false

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Get Message Attachment

<outlook365:get-message-attachment>

Reads the properties and relationships of an attachment that is attached to a user message. You can append the path segment /$value to get the raw contents of a file or item attachment.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

ID of the message that retrieves an attachment.

x

Attachment Id

String

ID of the attachment that the message retrieves.

x

O Data Query Params

Additional query parameters or filters.

Mail Folder Id

String

Mail folder that holds the message.

Get Raw Content

Boolean

Indicates whether to get the raw content of the attachment or not.

false

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

List Event Attachments

<outlook365:list-event-attachments>

Retrieves a list of attachment objects attached to an event. If not specified by the Top parameter, the default page size is 300.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Event Id

String

ID of the event that performs the action.

x

O Data Query Params

Additional query parameters or filters.

Calendar Id

String

ID of the calendar that holds the event.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Message of Binary payload and Void attributes

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

List Events

<outlook365:list-events>

Gets a list of event objects from the user’s mailbox. The list contains single instance meetings and series masters. Currently, this operation returns event bodies in only HTML. If not specified by the Top parameter, the default page size is 300.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

O Data Query Params

Additional query parameters or filters.

Outlook Time Zone

String

Time zone for the start and end times in the response.

Outlook Body Content Type

Enumeration, one of:

  • TEXT

  • HTML

Content type of the event body returned.

HTML

Calendar Id

String

ID of the calendar that holds the event.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Message of Binary payload and Void attributes

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

List Message Attachments

<outlook365:list-message-attachments>

Retrieves a list of attachment objects attached to a message. If not specified by the Top parameter, the default page size is 300.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

Message that performs the action.

x

O Data Query Params

Additional query parameters or filters.

Mail Folder Id

String

Mail folder that holds the message.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Message of Binary payload and Void attributes

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

List Messages

<outlook365:list-messages>

Gets the messages from the signed-in user’s mailbox, including the Deleted Items and Clutter folders. If not specified by the Top parameter, the default page size is 300.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

O Data Query Params

Additional query parameters or filters.

Outlook Body Content Type

Enumeration, one of:

  • TEXT

  • HTML

The format of the body and uniqueBody properties to return.

HTML

Mail Folder Id

String

ID of the mail folder that holds the message.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Array of Message of Binary payload and Void attributes

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Move Message

<outlook365:move-message>

Moves a message to another folder within the specified user’s mailbox. This creates a new copy of the message in the destination folder and removes the original message.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

ID of the previously created message entity.

x

Destination Id

String

ID of the destination folder.

x

Mail Folder Id

String

ID of the mail folder that holds the message.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Reply All To Message

<outlook365:reply-all-to-message>

Replies to all recipients of a message using either JSON or MIME format. The message is then saved in the Sent Items folder.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

ID of the message that replies to all.

x

Mail Folder Id

String

ID of the mail folder that holds the message.

Request Body Content Format

Enumeration, one of:

  • APPLICATION_JSON

  • MIME

Content type for the request payload.

APPLICATION_JSON

Reply

Any

Message to publish.

#[payload]

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Reply To Message

<outlook365:reply-to-message>

Replies to the sender of a message using either JSON or MIME format.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

ID of the message that replies to all.

x

Mail Folder Id

String

ID of the mail folder that holds the message.

Request Body Content Format

Enumeration, one of:

  • APPLICATION_JSON

  • MIME

Content type for the request payload.

APPLICATION_JSON

Reply

Any

Message to publish.

#[payload]

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Send Mail

<outlook365:send-mail>

Sends the message specified in the request body. The message is saved in the Sent Items folder by default.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message

Any

Message to send.

#[payload]

Request Body Content Format

Enumeration, one of:

  • APPLICATION_JSON

  • MIME

Content type for the request payload.

APPLICATION_JSON

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Send Message

<outlook365:send-message>

Sends a message from the draft folder. The draft message can be a new message draft, reply draft, reply-all draft, or forward draft. The message is then saved in the Sent Items folder.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

Message to send.

x

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Unauthorize

<outlook365:unauthorize>

Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without first repeating the authorization dance.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner for whom to invalidate access.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

For Configurations

Update Event

<outlook365:update-event>

Updates the properties of the event object. When updating the time zone of the start or end time of an event, first find the supported time zones to ensure you set only time zones that have been configured for the user’s mailbox server.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Event Id

String

ID of the event that performs the action.

x

Event Fields To Be Updated

Object

Properties for the event to update.

#[payload]

Calendar Id

String

ID of the calendar that holds the event.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Update Message

<outlook365:update-message>

Updates the properties of a message object.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

ID of the user who performs the action.

x

Message Id

String

ID of the message to update.

x

Message Fields To Be Updated

Object

Map containing keys as the fields to update and values as the new values for the update.

#[payload]

Mail Folder Id

String

ID of the mail folder that holds the message.

Read Timeout

Number

Read timeout value. Used to override the read timeout values defined in the connector configuration.

Read Timeout Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit value for the Read Timeout field.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Object

For Configurations

Throws

  • OUTLOOK365:BAD_REQUEST

  • OUTLOOK365:CONNECTIVITY

  • OUTLOOK365:FORBIDDEN

  • OUTLOOK365:INVALID_CONNECTION

  • OUTLOOK365:INVALID_CREDENTIALS

  • OUTLOOK365:NOT_FOUND

  • OUTLOOK365:RETRY_EXHAUSTED

  • OUTLOOK365:SERVER_ERROR

  • OUTLOOK365:TIMEOUT

  • OUTLOOK365:VALIDATION

Sources

On Modified Event

<outlook365:modified-event-listener>

Initiates a flow when an event is modified.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID or user principal name that performs the action.

x

Body Content Type

Enumeration, one of:

  • TEXT

  • HTML

The format of the body and uniqueBody properties to return.

HTML

Since

String

Date in the yyyy-MM-dd’T’HH:mm:ss’Z' format, for example, 2014-01-01T00:00:00Z. If this field is empty, the operation retrieves the selected objects from the time the Mule app starts.

Read Timeout

Number

Specifies the amount of time in milliseconds that the consumer waits for a response before it times out.

60

Read Timeout Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

SECONDS

Outlook Time Zone

String

Time zone for the start and end times in the response.

Calendar Id

String

ID of the calendar that contains the event.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

On New Email

<outlook365:new-email-listener>

Initiates a flow when a new email is received.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID or user principal name that performs the action.

x

Body Content Type

Enumeration, one of:

  • TEXT

  • HTML

The format of the body and uniqueBody properties to return.

HTML

Since

String

Date in the yyyy-MM-dd’T’HH:mm:ss’Z' format, for example, 2014-01-01T00:00:00Z. If this field is empty, the operation retrieves the selected objects from the time the Mule app starts.

Read Timeout

Number

Specifies the amount of time in milliseconds that the consumer waits for a response before it times out.

60

Read Timeout Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

SECONDS

Mail Folder Id

String

ID of the mail folder from which to get the messages.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

On New Event

<outlook365:new-event-listener>

Initiates a flow when a new event is detected.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

User Id

String

User ID or user principal name that performs the action.

x

Body Content Type

Enumeration, one of:

  • TEXT

  • HTML

The format of the body and uniqueBody properties to return.

HTML

Since

String

Date in the yyyy-MM-dd’T’HH:mm:ss’Z' format, for example, 2014-01-01T00:00:00Z. If this field is empty, the operation retrieves the selected objects from the time the Mule app starts.

Read Timeout

Number

Specifies the amount of time in milliseconds that the consumer waits for a response before it times out.

60

Read Timeout Time unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Read Timeout field.

SECONDS

Outlook Time Zone

String

Time zone for the start and end times in the response.

Calendar Id

String

ID of the calendar that contains the event.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Primary Node Only

Boolean

Determines whether to execute this source on only the primary node when running Mule instances in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Any

For Configurations

Types

Proxy Configuration

Configures the settings used to connect through a proxy.

Field Type Description Default Value Required

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Keystore

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.

Type

String

Type of store used.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

Verify only the last element in the certificate chain.

  • false

Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

Check the Certification Revocation List (CRL) for certificate validity.

  • false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

Avoid verification failure.

  • false

Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certicate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

Allow the deployment to fail.

  • false

Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.

Field Type Description Default Value Required

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

Redelivery Policy Message Identifier

Configures how to identify a redelivered message and how to find out when the message was redelivered.

Field Type Description Default Value Required

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Id Expression

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

Repeatable In Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field Type Description Default Value Required

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

O Data Query Params

Field Type Description Default Value Required

Select

String

Count

Boolean

false

Expand

String

Filter

String

Format

String

Order By

String

Search

String

Skip

Number

Top

Number

Repeatable In Memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the Buffer Size Increment field, with an upper limit of maxInMemorySize.

100

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

100

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

In Memory Objects

Number

The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Objects field.