> Managing Service Providers and Applications > Managing mailboxes

Managing Service Providers and Applications

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Managing mailboxes

Mailboxes are used by backwards compatible Short Messaging and Multimedia Messaging traffic paths.

 

About Mailbox administration

All messages used by the backwards compatible Parlay X Short Messaging and backwards compatible Parlay X Multimedia Messaging traffic paths are managed using mailboxes. Each application that uses the Messaging Service capability must have one or more mailboxes created and assigned to it. When it is created, each mailbox has an address.

Mailbox addresses can also be mapped to destination address short codes and message prefixes. The combination of a mailbox address, destination address short code and message prefix is called a mailbox translation.

 

Mailboxes

To create or delete mailboxes, use the following procedures.

Creating mailboxes

To create one or more mailboxes for an application account.

Note: As the number of mailboxes on BEA WebLogic Network Gatekeeper may become very large, doing searches on mailbox data can become quite time-consuming. As a result, keeping track of each application's mailboxes, mailbox address ranges, and mailbox passwords in a separate file - for example, an Excel file - is highly recommended.
  1. Identify a free address range to be used for the mailboxes. Check the file mentioned in the note above.
  2. Start in the configuration and operations page for ESPA_Messaging.
  3. List mailboxes using Operation: listMailboxes
  4. Verify that the address range is free.

    5. If the address range is free, no mailboxes will be displayed.

  5. To create a range of mailboxes, use Operation: createMailboxRange. To create a single mailbox, use Operation: createMailbox.

    6. The result is displayed and the mailboxes are created.

  6. Distribute the mailbox addresses and password to the service provider.

Deleting mailboxes by address

To delete one or more mailboxes based on address:

Note: Mailboxes can be deleted for individual addresses or by address range.
  1. Identify the mailbox address or address range in the file you created to keep track of the mailbox addresses.
  2. Start in the configuration and operations page for ESPA_Messaging.
  3. When the method list appears, verify that the address or address range you want to delete exists and that the desired service provider is the owner of all mailboxes to delete using Operation: listMailboxes.

    4. Check to make sure the range you wish to delete exists in the list that is displayed.

  4. Remove a rage of mailboxes using Operation: removeMailboxRange. Remove a single mailbox using Operation: removeMailbox.

The result is displayed in the Messages and the mailbox(es) are deleted.

Deleting mailboxes by owner (application)

To delete all mailboxes owned by a specific application:

  1. Identify the mailbox address or address range in the file you created to keep track of the mailbox addresses.
  2. Start in the configuration and operations page for ESPA_Messaging.
  3. Verify that the address or address range you want to delete exists for the owner (application) by using Operation: listMailboxesByOwner.
  4. Check to make sure the owner whose range you wish to delete exists in the list that is displayed.
  5. Remove the mailbox using Operation: removeMailboxByOwner.

The result is displayed and the application's mailbox(es) are deleted.

 

Message translation

To add or delete a mapping from a messaging mailbox to a short code and message prefix.

Adding a message translation

To specify a destination address short code and message prefix for a mailbox:

Note: The routing for the destination address short code towards BEA WebLogic Network Gatekeeper must be defined in the network.
  1. Start in the configuration and operations page for ESPA_Messaging.
  2. Verify the mailbox address using Operation: listMailboxes.

    3. Make sure the mailbox is displayed.

  3. List current translations using Operation: listMailboxTranslationsForAddress.

    4. The current translations for that mailbox are displayed.

  4. Add translation using Operation: addMailboxTranslation.

The result is displayed in the Messages pane and the message translation is added.

Deleting a message translation

To delete a message translation for a mailbox.

  1. Start in the configuration and operations page for ESPA_Messaging.
  2. List current translations using Operation: listMailboxTranslationsForAddress.

The current translations are displayed.

  1. Delete translation using Operation: deleteMailboxTranslation.
Note: The actual mailboxes must be deleted separately. See Deleting mailboxes by address or Deleting mailboxes by owner (application) for more information.

 

Reference of provisioning attributes and operations for mailboxes

Below is a list of attributes and operations for configuration and maintenance for mailboxes in the managed object ESPA_messaging:

Operation: addMailboxTranslation

Scope: Domain

Adds a mailbox translation rule.

Signature: 

addMailboxTranslation(destAddr:String, msgPrefix:String, mailbox:String)



 
Table 10-1  addMailboxTranslation



  
    
 
addMailboxTranslation





  
    
 
Parameter



    
 
Description





  
    
 
destAddr 



    
 
The destination address short code to be used instead of the real mailbox address.





  
    
 
 msgPrefix 



    
 
The keyword to be entered in the beginning of the message. The message prefix is case sensitive. If left empty, this mailbox will be the default mailbox for the destination address short code. That is, it will be used for messages that does not start with a valid message prefix.





  
    
 
 mailbox 



    
 
 The ID of the mailbox to route to translate to.

Operation: createMailbox

Creates a new mailbox.

Signature: 

createMailbox(addr:String, applicationId:String, serviceProviderId:String, pwd:String)



 
Table 10-2  createMailbox



  
    
 
createMailbox





  
    
 
Parameter



    
 
Description





  
    
 
addr 



    
 
 Mailbox ID. 





  
    
 
 applicationId 



    
 
 The application account ID for the application using the mailbox.





  
    
 
 serviceProviderId 



    
 
The service provider account ID.





  
    
 
 pwd 



    
 
A password to be used by the application when accessing the mailboxes.

Operation: createMailboxRange

Creates a range of new mailboxes.

Signature: 

createMailboxRange(startAddr:String, endAddr:String, applicationId:String, serviceProviderId:String, pwd:String)

Table 10-3 createMailboxRange
createMailboxRange
 
Parameter
Description
startAddr
The first address in a range of free internal mailbox addresses in Network Gatekeeper. You do not have to enter the service centre address part of the mailbox address.
Integer (leading zeroes might have to be added to the internal mailbox address. This depends on the address format used).
endAddr
The last address in a range of free internal mailbox addresses. Must be greater than the address in startAddr.
applicationID
The application account ID of the application using the mailbox.
serviceProviderID
The service provider account ID.
pwd
A password to be used by the application when accessing the mailboxes.

Operation: deleteMailboxTranslation

Deletes a mailbox translation.

Signature: 

deleteMailboxTranslation(destAddr:String, msgPrefix:String)

Table 10-4 deleteMailboxTranslation
deleteMailboxTranslation
Parameters
Description
destAddr
The destination address short code used instead of the real mailbox address.
msgPrefix
The keyword to be entered in the beginning of the message. The message prefix is case sensitive.
If left empty, all message translations related to the destination address short code will be deleted.

Operation: listMailboxTranslationsForAddress

Lists all mailbox translation rules for a specific address. 

listMailboxTranslationsForAddress(destAddr:String)

Table 10-5 emptyMailbox
emptyMailbox
Parameters
Description
destAddr
The address for which to list mailbox translations.

Operation: listMailboxes

List a range of mailbox IDs and which service provider account and application account the mailboxes.

Signature: 

listMailboxes(fromAddress:String, toAddress:String)

Table 10-6 listMailboxes
listMailboxes
Parameters
Description
fromAddress
The ID of the first mailbox in the range.
toAddress
The ID of the last mailbox in the range.
If set to 0, no last address in the range is given but instead the next 50 mailboxes, starting with the fromAddress, will be included in the list.

Operation: listMailboxesByOwner

Lists the IDs of all mailboxes belonging to a given service provider and application. 

listMailboxesByOwner(applicationId:String, serviceProviderId:String)

Table 10-7 listMailboxesByOwner
listMailboxesByOwner
Parameters
Description
applicationId
The application account ID.
serviceProviderId
The service provider account ID.

Operation: removeMailbox

Deletes a mailbox.

Signature: 

removeMailbox(addr:String)

Table 10-8 removeMailbox
removeMailbox
Parameters
Description
addr
The mailbox ID

Operation: removeMailboxByOwner

Deletes all mailboxes owned by a given service provider account and application account.

Signature: 

removeMailboxByOwner(applicationId:String, serviceProviderId:String)

Table 10-9 removeMailboxByOwner
removeMailboxByOwner
Parameters
Description
applicationId
The application account ID.
serviceProviderId
The service provider account ID.

Operation: removeMailboxRange

Deletes a range of mailboxes.

Signature: 

removeMailboxRange(startAddr:String, endAddr:String)

Table 10-10 removeMailboxRange
removeMailboxRange
Parameters
Description
startAddr
The ID of the first mailbox in the range.
endAddr
The ID of the last mailbox in the range.


  Back to Top       Previous  Next