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 Name File Gateway Create Partner Mailbox Service
Graphical Process Modeler (GPM) category Not applicable
Description This service creates mailboxes to match the specified directory path and grants mailbox access to the partner's users.
Business usage This 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 example The system uses this service.
Preconfigured? Yes
Requires third party files? No
Platform availability All platforms supported by the application
Related services None
Application requirements None
Initiates business processes? No
Invocation Yes. 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

Restrictions This service is only called by Sterling File Gateway and cannot be customized.
Persistence level System default
Testing considerations None

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
MailboxPath The full absolute mailbox path to create. Any string. Required.
PartnerKey The 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.