MozillaThunderbirdConfigurationGuide

forversion2.2.9

MozillaThunderbirdConfigurationGuide
Version2.2.9-September2014
Permissionisgrantedtocopy,distributeand/ormodifythisdocumentunderthetermsoftheGNUFreeDocumentationLicense,Version
1.2oranylaterversionpublishedbytheFreeSoftwareFoundation;withnoInvariantSections,noFront-CoverTexts,andnoBack-Cover
Texts.Acopyofthelicenseisincludedinthesectionentitled"GNUFreeDocumentationLicense".
ThefontsusedinthisguidearelicensedundertheSILOpenFontLicense,Version1.1.ThislicenseisavailablewithaFAQat:http://
scripts.sil.org/OFL
CopyrightukaszDziedzic,http://www.latofonts.com,withReservedFontName:"Lato".
CopyrightRaphLevien,http://levien.com/,withReservedFontName:"Inconsolata".

TableofContents
About this Guide .............................................................................................................. 1
Introduction ..................................................................................................................... 2
Installation ....................................................................................................................... 3
Mozilla Thunderbird .................................................................................................. 3
Mozilla Lightning ...................................................................................................... 3
SOGoConnectorandSOGoIntegrator.......................................................................4
SOGoIntegratorCustomization......................................................................................... 5
Customization .......................................................................................................... 5
SOGo Update Server ........................................................................................................ 7
Installation ............................................................................................................... 7
Configuration ........................................................................................................... 7
Additional Information ..................................................................................................... 10
CommercialSupportandContactInformation................................................................... 11

iii

Chapter1

AboutthisGuide

ThisguidewillwalkyouthroughtheinstallationandconfigurationofMozillaThunderbirdandits
associatedextensionssoitcanbeusedwiththeSOGosolution.
Theinstructionsarebasedonversion2.2.9ofSOGo.
Thelatestversionofthisguideisavailableathttp://www.sogo.nu/downloads/documentation.html.

AboutthisGuide

Chapter2

Introduction

SOGoisafreeandmodernscalablegroupwareserver.Itofferssharedcalendars,addressbooks,and
emailsthroughyourfavouriteWebbrowserandbyusinganativeclientsuchasMozillaThunderbird
andLightning.
SOGoisstandard-compliant.ItsupportsCalDAV,CardDAV,GroupDAV,iMIPandiTIPandreuses
existingIMAP,SMTPanddatabaseservers-makingthesolutioneasytodeployandinteroperable
withmanyapplications.
SOGofeatures:
Scalablearchitecturesuitablefordeploymentsfromdozentomanythousandusers
Rich Web-based interface that shares the look and feel, the features and the data of Mozilla
ThunderbirdandLightning
ImprovedintegrationwithMozillaThunderbirdandLightningbyusingtheSOGoConnectorand
theSOGoIntegratorextensions
Two-way synchronization support with any Microsoft ActiveSync-capable device, or Outlook
2013
SOGoisdevelopedbyacommunityofdeveloperslocatedmainlyinNorthAmericaandEurope.
Moreinformationcanbefoundonhttp://www.sogo.nu/.

Introduction

Chapter3

Installation

ThissectionwillguideyouthroughtheinstallationofThunderbirdanditsassociatedextensions.

MozillaThunderbird
MozillaThunderbirdistheofficialfrontendclientofSOGo.
MozillaThunderbirdversion2,3.1,10ESR(ExtendedSupportRelease),17ESR,24and31are
supportedanditisrecommendedtouseversion31ofThunderbird.
InordertodownloadandinstallMozillaThunderbird,pleasevisit:
https://www.mozilla.org/en-US/thunderbird/organizations/all-esr.html

MozillaLightning
Whenusingversion24or31ofThunderbird,youcanusethelatestversionofMozillaLightning.
UsetheAdd-onsmanagerofThunderbirdorvisit:
https://addons.mozilla.org/en-US/thunderbird/addon/lightning/
Whenusingversion17ESRofThunderbird,youcanuseMozillaLightningversion1.9.1.Inorder
todownloadtheextension,pleasevisit:
https://addons.mozilla.org/en-US/thunderbird/addon/lightning/versions/?page=1#version-1.9.1
ForThunderbird2and3.1,youneedthe_InverseEdition_ofMozillaLightning.Itprovidesback
portedfeatures,bugfixesandsecurityfixesfromthecurrentdevelopmentversionofMozillaLightning.ForThunderbird2,itisbasedonreleaseversion0.9ofLightning.ForThunderbird3.1,itis
basedon1.0b2.
InordertodownloadandinstallMozillaLightningInverseEditionforThunderbird2or3.1,please
visit:
http://www.sogo.nu/downloads/frontends.html

Installation

Chapter3

SOGoConnectorandSOGoIntegrator
TheSOGoConnectorandIntegratorextensionsareprovidedtoperfecttheintegrationofMozilla
Thunderbird2,3.1,10ESR,17ESR,24and31withtheSOGogroupwaresolution.
Firstofall,theSOGoConnectorextensiontransformsThunderbirdintoafullDAVclientforgroupwareserverssuchasSOGo,eGroupwareorCitadel.ItdoesthisbyaddingsupportforremoteDAV
addressbooksandbyaddingfeaturestobeusedalongwiththeLightningcalendarextension.
AmongsupportedfeaturesoftheSOGoConnectorextension,wehave:
Free/BusyURLfieldintheaddressbook
Free/BusyfunctionalitythroughHTTP
Eventorganizers
SynchronizationoftheaddressbookusingGroupDAV
CardDAVimplementationfortheaddressbook
SupportforWebDAVACL
Ontheotherhand,theSOGoIntegratorextensiontransformsThunderbirdintoapure"heavy"client
forSOGo.WhereastheSOGoConnectorismeantforportability(horizontalintegration),theSOGo
IntegratormakesuseofthefeaturesandlayoutonlyavailablefromSOGo(verticalintegration).
AmongthesupportedfeaturesoftheSOGoIntegratorextension,wehave:
Remoteadministrationoffoldersubscriptions
Remoteadministrationoffolderaccesscontrollists(ACL)
Automaticreplicationofyourlocalandsubscribedfolders
Whencorrectlyconfigured,ithandlesthepropagationofupdatestochosenextensionsfroma
localupdateserver
Automaticpropagationofdefaultsettings
InordertodownloadandinstalltheSOGoConnectorandIntegratorextensions,pleasevisit:
http://www.sogo.nu/downloads/frontends.html
PriortoinstallingtheSOGoIntegratorextension,youshouldreadthefollowingchapterSOGo
IntegratorCustomization.

Installation

Chapter4

SOGoIntegratorCustomization

In this section, youll learn how to customize the SOGo Integrator extension so it can be used
alongsideyourSOGoserver.

Customization
ThecustomizationstepsdescribedhereinvolvesunderstandingofXMLandoftextfileedition.If
youdonothavethoseskills,itisrecommendedthatyoudonttrytousethisextension.
ThereareactuallytwostepsintheconfigurationofaworkingenvironmentforSOGoIntegrator.
Firstofall,theIntegratorwillusethesameusernameusedtoconnecttothefirstemailserver
configuredinThunderbird.Itisacurrentlimitationbutitwillfitnearlyallconfigurationsoutthere.
For testing purpose, you are strongly recommended to create and configure an additional user
profileforThunderbird.Thisisfortworeasons.Thefirstisbecauseofthelimitationmentioned
above.ThesecondisbecausetheIntegratorwillsynchronizeyourpersonaladdressbookontothe
SOGoserverandthenremoveitsothatonlyyourpersonaladdressbookonSOGowillbeavailable.
Ifyouarenotabletodothat,youmaywanttomakeacopyofthataddressbookbeforehand.
ThesecondpartrequireseditingonefileintheextensionfilesubtreetospecifywheretheSOGo
serverislocated.Thisisdonebyhand.Inanenterpriseenvironment,thisstepisonlyrequiredonce
perreleasesincetheupdatesareexpectedtopropagateautomatically.
Uncompress(usingaZIPorjartool)theSOGoIntegratorXPIandlocatethefollowingfile:
extensions.rdf
ThisfileisusedforlocatingtheextensionupdateserverandtheSOGoserver,whichweconsider
tobethesameforthemoment.Thereisalinestartingwitha"Seq"tagandwithanattributenamed
"isi:updateURL".ReplacethehostpartofthaturlwiththeSOGoserveryouwanttoconnectto.
Forexample,onewouldreplace:
<Seq about="http://inverse.ca/sogo-integrator/extensions" isi:updateURL="http://
sogo-demo.inverse.ca/plugins/updates.php?plugin=%ITEM_ID%&amp;version=
%ITEM_VERSION%&amp;platform=%PLATFORM%">
by:

SOGoIntegratorCustomization

Chapter4

<Seq about="http://inverse.ca/sogo-integrator/extensions" isi:updateURL="https://

sogo.acme.com/plugins/updates.php?plugin=%ITEM_ID%&amp;version=%ITEM_VERSION
%&amp;platform=%PLATFORM%">
iftheSOGoserverisaccessiblefromthefollowingURL:
https://sogo.acme.com/SOGo
Note that if you changed the x-webobjects-server-url configuration setting from your HTTP
serverconfigurationfileforSOGo,thevaluemustmatchtheoneyouspecifyinisi:updateURL
eventheportnumber.
Moreover,youmustchangethevalueofthesogo-integrator.autocomplete.server.urlidpreferencefromdefaults/preferences/site.jstomatchtheidentifierofyourSOGoUserSources.This
sourcewillbeusedbyThunderbirdforautocompletion.
Onceyouredonemodifyingtheconfigurationfile,saveyourchangesandreconstructtheXPIfile.
NowstartThunderbirdandinstallyournewlymodifiedextension.

SOGoIntegratorCustomization

Chapter5

SOGoUpdateServer

Inthissection,youwilllearnhowtoinstallandconfiguretheSOGoUpdateServer.
TheSOGoUpdateServercanbeusedtoautomaticallyinstalloruninstallMozillaThunderbirdextensions,pushusersettingsandmoreallfromacentralplacemanagedbysystemadministrators.

Installation
Installationisrelativelystraightforward.Youneedtomaketheupdates.phpscriptavailablethrough
yourHTTPserverattheURLyouvespecifiedfromtheextensions.rdffile.Theupdates.phpscript
canbefoundintheSOGosources,undertheScriptsdirectory.
TheupdateLinksectionoftheXMLpayloadreturnedtosogo-integratorisbuiltdynamicallyusing
theSCRIPT_URIvariable,whichisonlyavailablewhenrunningwithmod_rewrite.Itshouldworkout
oftheboxaslongasthescriptisplacedinthesamedirectoryasthexpifiles.
Ifitisnotthecase,thenthelinkshouldbeadjustedtofittheactualfilelayout:
<em:updateLink><?php echo dirname(getenv('SCRIPT_URI')) . '/relative/path/to/' .
$plugin["filename"] ?></em:updateLink>
Anhttprequestsimilartothefollowingcanbeusedtomakesurethatthegeneratedlinkiscorrect:
http://sogo.host/path/to/updates.php?plugin=sogointegrator@inverse.ca&version=0.00
PleaserefertoyourHTTPserverdocumentationfortheinstallationandconfigurationofPHP.

Configuration
ToconfiguretheSOGoupdateserver,youneedtomodifytheupdates.phpscriptdirectly.
Addinganextensiontobepushedautomaticallybytheupdateserverrequireyoutomodifythe
$pluginsarrayfromupdates.phpandalsoadjustaccordinglySOGoIntegratorsextensions.rdf
file.
SOGoUpdateServer

Chapter5
Forexample,toautomaticallyinstallSOGoConnector,SOGoIntegratorandLightning,youwould
have:
$plugins
= array( "sogo-connector@inverse.ca"
=> array( "application" => "thunderbird",
"version" => "31.0.0",
"filename" => "sogo-connector-31.0.0.xpi" ),
"sogo-integrator@inverse.ca"
=> array( "application" => "thunderbird",
"version" => "31.0.0",
"filename" => "sogo-integrator-31.0.0-sogo-demo.xpi" ),
"{e2fda1a4-762b-4020-b5ad-a41df1933103}"
=> array( "application" => "thunderbird",
"version" => "3.3.1",
"filename" => "lightning.xpi" ));
Thesyntaxis:
"<extension ID>"
=> array( "application" => "thunderbird",
"version" => "<exact version found in the extension's
install.rdf file>",
"filename" => "<exact filename on the filesystem>" )
Thepathofthefilename,specifiedinthefilenameparameter,isrelativetothelocationofthe
updates.phpscript.Forextensionsthataredependantonthearchitectureandoperatingsystem
(MicrosoftWindows,AppleMacOSX,etc.),theycanbeplacedinsubdirectoriesrelativeagainto
theupdates.phpscript(butthefilenamemustbeidenticalinallsubdirectories).Forexemple,for
MozillaLightning,wecouldhave:
Darwin_x86-gcc3/lightning.xpi
Linux_x86-gcc3/lightning.xpi
Linux_x86_64-gcc3/lightning.xpi
WINNT_x86-msvc/lightning.xpi
Ifyoueventuallywanttodisableanextension,thatis,withoutremovingitfromyourusers'computers,youcanspecifydisabledastheversionnumber.
Nextistomodifytheextensions.rdffile.Again,toautomaticallyinstallSOGoConnector,SOGo
IntegratorandLightning,youwouldhave:

SOGoUpdateServer

Chapter5

<li>
<Description
em:id="{e2fda1a4-762b-4020-b5ad-a41df1933103}"
em:name="Lightning"/>
</li>
<li>
<Description
em:id="sogo-integrator@inverse.ca"
em:name="SOGo Integrator"/>
</li>
<li>
<Description
em:id="sogo-connector@inverse.ca"
em:name="SOGo Connector"/>
</li>
UsingSOGoIntegrator,youcanalsopushuser-settingsforanypartofThunderbirdoritsextensions.
Therearetwokindofuser-settingspush:
SettingsthatarepushedduringtheinitialconfigurationofThunderbird
Settingsthatarepusheduponeveryrestart(ie.,forced)ofThunderbird
Settingsthatpushedarepushedduringinitialconfigurationarecontrolledbythe./defaults/preferences/site.jsfilefromSOGoIntegrator.Hereisanexample:
pref("calendar.alarms.showmissed", false);
pref("calendar.caldav.sched.enabled", true);
PreferencesthatareforceduponeveryrestartofThunderbirdarecontrolledfromthe./chrome/
content/general/custom-preferences.jsconfigurationfile.
Hereisanexample:
force_int_pref("changequote.replyformat.format", 0);
force_bool_pref("changequote.headers.withcc", true);
force_char_pref(foo.bar, zot);

SOGoUpdateServer

Chapter6

AdditionalInformation

Formoreinformation,pleaseconsulttheonlineFAQs(FrequentlyAskedQuestions):
http://www.sogo.nu/english/support/faq.html
Youcanalsoreadthemailingarchivesorpostyourquestionstoit.Fordetails,see:
https://lists.inverse.ca/sogo

AdditionalInformation

10

Chapter7

CommercialSupportandContact
Information

Foranyquestionsorcomments,donothesitatetocontactusbywritinganemailto:
support@inverse.ca
Inverse(http://inverse.ca)offersprofessionalservicesaroundSOGotohelporganizationsdeploy
thesolutionandmigratefromtheirlegacysystems.

CommercialSupport
andContactInformation

11