/n software Connectors for MuleSoft

Questions / Feedback?

Message Formatting

This section provides information about the data types used by and produced by the connectors. It provides detailed information about formatting the input message and also lists the required input data types and relevant fields for each connector.

This section does not cover data transformations or DataWeave operations. For information about the Mule expression language, please see MuleSoft's DataWeave Overview. For details on getting started, please see our Installation Instructions

Input Messages

A connector can require that certain information be present in the incoming message payload. An incoming message refers to the Mule Message inside the event which travels through the connectors of your application. This is not to be confused with connector configuration which is typically done through the configuration page or Config XML.

Source connectors do not require an input message since they are responsible for generating events (e.g. AS4 Receive, Email Receive, etc.). On the other hand, message processors in the body of the flow usually operate on data residing in the message payload.

Data Types

Message processors have specific requirements for the type of data in the incoming payload. For example, both FTP Send Connector and SFTP Send Connector have an input type of Binary, meaning they expect a stream of data to be present in the message payload.

A processor can have additional requirements on the input message, such as the inner payload must be provided in an Array or Map structure. As a good rule of thumb, the input message must be formatted correctly for that connector.

Below is a summary of the possible data types of input messages and output messages to the connectors that you will see.

  • Binary: A stream of bytes (Java InputStream or OutputStream)
  • Array<Binary>: An array of streams (DataWeave Arrays)
  • Map<String, Binary>: An object which maps a String to a Binary stream. (DataWeave Objects)
  • Null: Nothing. An empty reference.
  • N/A: Does not apply to this connector.

It is up to you to transform the incoming Mule Message into a form which is usable by the message processor.

Connector Input Output Relevant Fields
AS2 Send Binary Binary AS2To, AS2From, and URL
AS2 Receive Binary Binary TradingPartner and ReceivingPartner
AS4 Send Binary Binary AS2To, AS2From, and URL
AS4 Receive N/A Binary URL and MPC
AS4 Web Receive Binary Binary TradingPartner and ReceivingPartner
Email Send Binary Null SMTPServer From, and SendTo
Email Receive N/A Binary ServerType MailServer, and User
FTP Send Binary Null FTPServer and RemoteFile
FTP Receive N/A Binary FTPServer and RemotePath
HTTP Send Binary Binary HTTPMethod and URL
HTTP Receive N/A Binary HTTPMethod and URL
LDAP Send Binary Binary Server, Port, BindDN and Operation
OFTP Send Binary Null OFTPServer
OFTP Receive N/A Binary OFTPServer
REST Send Binary Binary HTTPMethod and URL
SCP Send Binary Null SSHHost and RemoteFile
SCP Receive N/A Binary SSHHost
Sexec Send Binary Binary SSHHost
SFTP Send Binary Null SSHHost and RemoteFile
SFTP Receive N/A Binary SSHHost
SQS Send Binary Null AccessKey SecretKey, and Queue
SQS Receive N/A Binary AccessKey SecretKey, and Queue
SSH Send Binary Binary SSHHost
WebDAV Send Binary Null URL and RemoteFile
WebDAV Receive N/A Binary URL and FileMask
XMPP Send Binary Null IMServer IMPort, and ToJID

Module Input Output Relevant Fields
AES Encode Binary Binary KeyPassword
AES Decode Binary Binary KeyPassword
Bzip2 Encode Array<Binary> Binary
Bzip2 Decode Binary Array<Binary>
EzCrypt Encode Binary Binary Algorithm and KeyPassword
EzCrypt Decode Binary Binary KeyPassword
Gzip Encode Binary Binary
Gzip Decode Binary Binary
Hash Encode Binary Binary Algorithm
OpenPGP Encode Binary Binary EncryptData and RecipientKey
OpenPGP Decode Binary Binary Key
SevenZip Encode Map<String, Binary>Binary
SevenZip Decode Binary Map<String, Binary>
SMIME Encode Binary Binary EncryptData and RecipientCert
SMIME Decode Binary Binary DecryptData and Certificate
Zip Encode Map<String, Binary>Binary
Zip Decode Binary Map<String, Binary>

Copyright (c) 2022 /n software inc. - All rights reserved.
/n software Connectors for MuleSoft - Version 20.0 [Build 8318]