A Partner Mailbox Endpoint allows CIC to act as an FTP or SFTP server. Your trading partners can connect to a Partner Mailbox as an FTP or SFTP client or as a Cleo Portal client. See Connecting to a Partner Mailbox.

A Partner Mailbox Endpoint can be used in multiple Data Flows, depending on whether it is a source or destination endpoint and the mailbox folder you choose. If used as a source endpoint, a folder with Upload permissions can only be used once. If used as a target endpoint, a folder with Download permissions can be used more than once. See Using Mailbox Folders for more details.

If you use a Partner Mailbox Endpoint as the source in a Data Flow with a Transformation Endpoint as the destination, you can use information about Partner Mailbox subfolders to help direct processing within your integration. See Processing Payloads based on the Endpoint Subfolders.

Partner Mailbox attributes

The Partner Mailbox Endpoint has the following attributes:

Accounts

Use this section to define the accounts allowed to log in to this Partner Mailbox. Add accounts to this Partner Mailbox as required by clicking Add another account.

Each account has the following attributes.

Mailbox Folders Tab

This tab allows you to configure folders from which you can send and receive files. See Using Mailbox Folders for details about how to configure folders.

Open PGP Tab

Use this tab to specify parameters and settings related to Open PGP.

Inbound

Outbound

Advanced Tab

Use this tab to specify parameters and settings across several different areas.

OpenPGP Algorithms

General

Connections and Transfers

Connecting to a Partner Mailbox

Once you have configured a Partner Mailbox, you can access it via FTP, FTPS, SFTP, and the Cleo Portal. Connection information is generated when Cleo configures your system for you.  It is possible to have multiple subdomains configured. Contact your system administrator for more information about your specific configuration.

Your connection information is displayed on the Partner Mailbox Endpoint page.

Using Mailbox Folders

By default, CIC provides two folders to use with your Partner Mailbox, Upload and Download, within your home folder. This section describes adding folders (directly under your home folder) and subfolders (under a folder other than home), deleting folders, editing folders, and some considerations for using folders in Data Flows.

Adding Folders and Subfolders

To add a folder directly under the home folder:

1. Without an existing folder selected, click the Add Folder button.

   

2. Name the folder, select permissions  (see Understanding Folder and User Permissions) and, if necessary, Allow Delete (see Allow Delete) and click Add. 

   

3. The new folder is added to your list of Mailbox Folders.

   

To add a subfolder:

1. Select the folder to contain the subfolder and click the Add Folder button.

   

2. Name the folder, select permissions (see Understanding Folder and User Permissions), and click Add.

   

3. A subfolder is added to the selected folder.

   

Deleting Folders

Select a folder and click the Delete Folder button.

When you delete a folder that contains subfolders, CIC deletes the folder and its subfolders.

If the folder you select to delete has download permissions and there is data in that folder, you must choose whether to move data to another folder or archive the data.

When you delete a folder and then save the Endpoint, CIC displays this warning and provides an opportunity to confirm the operation:

Renaming Folders and Editing Permissions

Select a folder, click the Edit Folder button, and edit the folder properties as necessary. See Understanding Folder and User Permissions and Allow Delete for details.

When you attempt to change permissions for a folder with Download permissions that contains data, you must choose whether to move the data to another folder or archive the data. 

Understanding Folder and User Permissions

Folder permissions reflect how the folder is used while user permissions pertain to the operations available for a given folder. Folder permissions comprise combinations of user permissions that apply to folders. 

You assign folder permissions when you create a folder. User permissions are assigned implicitly. The following table describes the relationship between folder and user permissions.

Allow Delete

Determines whether users are permitted to delete files from the folder.

This option is available only for linked folders with Permissions set to Download Only or Download & Upload. See Adding Folders and Subfolders.

When selected, users with access to the folder can delete files using their client (FTP, SFTP, or the Cleo Portal), subject to the folder’s assigned permissions. When not selected, users can upload and/or download files (depending on folder permissions) but cannot delete them.

Linking Partner Mailbox Folders

You can link Partner Mailbox folders to cloud storage Endpoints -- like S3, AzureBlob, and GCS -- and File System Endpoints. This configuration enables partners to upload and download data from a shared location and eliminates the need to upload copies of documents into each Partner Mailbox. However, these linked folders cannot be used by Data Flows. 

Notes: 

• You can only link folders that are direct children of the Partner Mailbox home folder.
• When you delete an Endpoint to which you have linked, any folders associated with that Endpoint are also deleted.
• Linked folders cannot have child folders.

To add a linked folder:

1. Open a Partner Mailbox Endpoint.
2. Scroll down to the Mailbox Folders section.

3. Select the home folder and click the Add button.

   

   The Add Folder dialog box displays.

   

4. Give your folder a name and select permissions. See Understanding Folder and User Permissions.

5. Click the Link folder to Endpoint enable/disable toggle. A list of available Endpoints displays.

   

6. Click an Endpoint to select it.

7. (Optional) Select the folder within the Endpoint you want to use. Click a folder from the displayed list or click the pencil icon to specify a path.

   

8. Click Select.

9. Click Add.

   

To link an existing folder or unlink a folder:

1. Select the folder.
2. Click the Edit button.
3. Click the Link folder to Endpoint enable/disable toggle.
4. Click Save. 
   Note: If linking to an existing folder, any data in the folder will be lost.

To delete a linked folder:

1. Select the linked folder you want to delete and click the Delete button.

   

Partner Mailbox commands

The following commands are available for Partner Mailbox Endpoints when the Data Flow runs.

PUT

Valid for Target Endpoints.

Send one or more files to a folder that has User Permissions of 'Download Only' or 'Download & Upload'.

PUT [-UNI|-APE] "source" "destination"

WAIT

Pause execution.

WAIT seconds