Sterling File Gateway - Create Partner Mailbox service

The File Gateway Create Partner Mailbox service creates mailboxes to match the specified directory path and grants mailbox access to the partner’s users.

The following table provides an overview of the File Gateway Create Partner Mailbox service:
System NameFile Gateway Create Partner Mailbox Service
Graphical Process Modeler (GPM) categoryNot applicable
DescriptionThis service creates mailboxes to match the specified directory path and grants mailbox access to the partner’s users.
Business usageThis is a system service. It is used to create mailboxes to match the specified directory path and grant mailbox access to the partner’s users.
Usage exampleThe system uses this service.
Preconfigured?Yes
Requires third party files?No
Platform availabilityAll platforms supported by the application
Related servicesNone
Application requirementsNone
Initiates business processes?No
InvocationYes. This service is invoked automatically in Sterling File Gateway processes and does not need to be modified.
Business process context considerations 
Returned status values

0 = Success

1 = Failure

RestrictionsThis service is only called by Sterling File Gateway and cannot be customized.
Persistence levelSystem default
Testing considerationsNone

Implementing the File Gateway Create Partner Mailbox service

This is a system service. You do not need to implement this service.

Configuring the File Gateway Create Partner Mailbox service

There are no configuration parameters for the File Gateway Create Partner Mailbox Service.

Parameters passed from business process to service

Field
Description
MailboxPathThe full absolute mailbox path to create. Any string. Required.
PartnerKeyThe key that represents the partner. This is used for the partner’s users permission to the created mailbox. Any string. Required.

Parameters passed from service to business process

There are no parameters passed from this service to a business process.

Previous Topic

Sterling File Gateway - Complete Delivery service

Parent Topic

Sterling File Gateway services

Next Topic

Sterling File Gateway - Route service