1. Home
  2. Knowledge Base
  3. Broadsoft Broadworks integration

Broadsoft Broadworks integration

In general, there is very little specific integration that will be needed, the Broadsoft VOIP system will use surgemail as it's backend storage mechanism and you shouldn't need to concern yourself too much with anything in surgemail.


Perform a normal surgemail installation. On windows just download the normal SurgeMail distribution (download button above) untar, and run the install.sh script, e.g.

   gunzip surgemail_XXX_linux.tar.gz 
   tar -xvf surgemail_XXX_linux.tar
  cd mtemp

Next add the domain name you wish to host with Broadsoft using the web admin tool
    Click on Domain Settings/New
        Enter the name of the domain, press save.

Add these settings to ensure the email from the broadworks system is accepted.
    G_GATEWAY_ALLOW "ip.address.of.broadworks.server"
    G_SPAM_ALLOW "ip.address.of.broadworks.server"

Provisioning/Creating User Accounts

If the server is not going to be visible to the internet then you can use the automatic account creation features.

For the domain in question set these settings in surgemail.ini (or using the web admin interface)

In rare cases you may use user_auto_always "true" to force it to accept any new password the user uses.

These two settings allow surgemail to just create any account that gets a message from the broadsoft server, and then correctly update the password when the first login attempt occurs.   SECURITY WARNING: It's essential that if these settings are used the server must NOT be accessable via any other system than the broadworks server.

If you wish the SurgeMail server to be accessed directly by users, then instead you must create the accounts using the web admin interface or via the api for user management.

If you have existing accounts on another system then you can use the pop/imap intercept mode settings to automatically create accounts, see the domain level settings old_pophost* and old_imaphost*

Quota/Disk management

You will almost certainly need to establish some kind of quota and disk management policy to prevent disk usage growing forever, the easiest method is to set a global quota:

g_quota_default "100mb"

and you may wish to set a rule to expire messages after 6 months (these are domain specific settings so they are set for each domain:

expire_age "180"

expire_size "1"

What to do if something goes wrong

Just consult the normal surgemail documentation, a good starting place is the don't panic guide.

Was this article helpful?