The following settings can be used in this section:
Enable
You can turn off all archiving using this switch
bool
On/Off, True/False, Yes/No, 1/0
On
Enable=On
Directory
directory in which to store the archives
text
archive
Directory=archive
NoMatchArchive
Email that does not match any configured virtual archive can be archived into the specified virtual archives, or if desired with no virtual archive associated with them.
bool
On/Off, True/False, Yes/No, 1/0
On
NoMatchArchive=On
CPUUsage
How much CPU to use while indexing email, and correspondingly how fast indexing will take place.
number
20 - 95
DiskUsage
number
75 - 100
DiskUsageAlert
number
75 - 100
90
DiskUsageAlert=90
DiskUsageStop
number
75 - 100
95
DiskUsageStop=95
ArchiveSource
Hexamail Guard can automatically archive all email from Exchange including inbound, outbound and internal email.
Exchange 5.5: this is not possible
Exchange 2000-2003: this is done using a feature in Exchange known as 'journaling'.
Exchange can be made to copy every email sent or received to a nominated mailbox.
Hexamail Guard then automatically periodically retrieves email from this mailbox and archives them into the Hexamail Guard compressed and indexed archive. At the same time it REMOVES them from the journaling account, in order that the account
does not grow without bound. The first step is to create an account in Exchange to use for journaling. This should be done in the normal way and called for example 'journal' with the email address/mailbox
journal@yourdomain.com. Once created, browse for and select the journal account for the Journal Mailbox in Hexamail. Hexamail Guard will automatically set up journaling in Exchange for you using this mailbox when you press the 'Enable Journaling'
button in Hexamail.
Exchange 2007, 2010, 2013 onwards this is done using mailbox extraction to PST as an intermediate step and those PSTs are then indexed and removed.
Exchange 2010, 2013: Due to limitations set by Microsoft a UNC share that is writable by Exchange and readable by Hexamail must be available for the processing of PST data.
text
off
ArchiveSource=off
ArchiveSource
Use this setting to have Hexamail Guard archive MDaemon emailboxes and SMTP email passing through Hexamail Guard
text
off
ArchiveSource=off
ArchiveMDaemonFolders
Setup the list of folders in which MDaemon mailboxes reside. You can specify the top level folder, a domain folder or individual account folders
text
ArchiveSource
Use this setting to have Hexamail Guard archive IMail emailboxes and SMTP email passing through Hexamail Guard
text
off
ArchiveSource=off
ArchiveIMailFolders
Setup the list of folders in which IMail mailboxes reside. You can specify the top level folder, a domain folder or individual account folders
text
ArchiveSource
Use this setting to have Hexamail Guard archive hMailserver emailboxes and SMTP email passing through Hexamail Guard
text
off
ArchiveSource=off
ArchiveHMailserverFolders
Setup the list of folders in which hMailserver mailboxes reside, usually the Data directory should be specified to collect all email. You can specify the top level folder, a domain folder or individual account folders
text
ArchiveSource
Use this setting to have Hexamail Guard archive zimbra emailboxes and SMTP email passing through Hexamail Guard
text
off
ArchiveSource=off
ArchiveZimbraFolders
Setup the list of folders in which Zimbra mailboxes reside.
You can specify the top level folder, a domain folder or individual account folders
text
/opt/zimbra/store/
ArchiveZimbraFolders=/opt/zimbra/store/
ArchiveSource
Use this setting to have Hexamail Guard archive maildir emailboxes and SMTP email passing through Hexamail Guard
text
off
ArchiveSource=off
ArchiveMailDirFolders
Setup the list of folders in which maildir mailboxes reside. You can specify the top level folder, a domain folder or individual account folders
text
ArchiveMailDirNew
Maildir stores new unread email in subfolders called 'new'. use this option to also index email from thee subfolders. usually on reading it will be moved into the 'cur' folder anyway and therefore indexed. If you have
setup a system such that mail accumulates in the new folders and is never 'read' by a client, use this setting to index it regardless. Duplicate email is removed from the index by Message-ID field anyway, but it is more efficient to avoid indexing email twice from the new and cur folders if normal email clients will be used to read the accounts.
bool
On/Off, True/False, Yes/No, 1/0
off
ArchiveMailDirNew=off
ArchiveSource
Use this setting to have Hexamail Guard archive only SMTP email passing through Hexamail Guard
text
off
ArchiveSource=off
ArchiveSource
Use this setting to have Hexamail Guard archive Hexamail mailboxes
text
off
ArchiveSource=off
ArchiveRedelivery
text
resmtp
ArchiveRedelivery=resmtp
ArchiveRedelivery
Use this setting to have Hexamail Guard restore email using SMTP. This is the simplest way to restore email to mailboxes.
Email will appear in the users inbox with the date of redelivery.
text
ArchiveRedelivery
Use this setting to have Hexamail Guard restore email using Echange Web Services.
Email can be pushed back into any Exchange mailbox folder and will appear with the original received date.
You will need to configure impersonation on your Exchange server and configure the Exchange Web Service settings
to allow this to operate.
To allow impersonation on your Exchange server please run this powershell script in the Exchange Powershell console on the server:
[PS] C:\Windows\system32>New-ManagementRoleAssignment -name:HexamailImpersonation -Role:ApplicationImpersonation -User:<username>
text
ArchiveContinuous
Use this setting to have Hexamail Guard continually scan mailboxes for new email. The Exchange importer does this automatically using journaling to get internal email. Other mailbox formats require this if you wish to continuously import new internal email.
If you setup the SMTP proxy archiving, then this option restricts itself to only archiving enw internal email as incoming and outbound email will be imported from the SMTP gateway directly.
bool
On/Off, True/False, Yes/No, 1/0
on
ArchiveContinuous=on
ArchiveInterval
Use this setting to set how often Hexamail Guard will check for new email in the mailboxes
number
1 - 10080 minutes
60 minutes
ArchiveInterval=60
ArchiveNice
A nice factor is a factor determining the priority of the importing process. 0 = import as fast as possible, 100 = import more slowly to minimize CPU and disk usage during import
number
1 - 100
50
ArchiveNice=50
ArchiveCacheSize
The cache size in MBytes you want to use for the indexer, per index.
number
256 - 16000 mbytes
256 mbytes
ArchiveCacheSize=512
ArchiveSegmentCount
You can break the archive into segments based on count. This allows older segments to be expired when no longer needed.
number
10 - 1000 thousand entries
1000 thousand entries
ArchiveSegmentCount=500
ArchiveSegmentAge
You can break the archive into segments based on age. This allows older segments to be expired when no longer needed
number
0 - 24000 days
180 days
ArchiveSegmentAge=30
ArchiveSegmentExpire
You can expire archive segments based on age (days).
This allows older segments to be expired when no longer needed. Set this to 0 for no expiry
number
0 - 24000 days
9999 days
ArchiveSegmentExpire=30
ArchiveSegmentExpireTo
You can move expired archive segments based to another disk or network location. The move will take place in the background
text
ArchiveSegmentExpireTo=\\backup\oldarchives\
ArchiveSegmentAuxPaths
You can optionally use additional index segments from another path ass econdary indices that will be used for longer-term, slower, queries.
text
ArchiveSegmentAuxPaths=\\backup\oldarchives\
ArchiveLanguage
The primary language used for indexing. This setting controls the stoplist and stemming algorithm used for full text indexing.
English stopping and stemming will also be used as a secondary language to ensure mixed content indexes well.
en
ArchiveLanguage=en
ArchiveQueryTimeout
The timeout to use for queries
number
5 - 600 seconds
60 seconds
ArchiveQueryTimeout=240
ArchiveSMTP
Use this setting to have Hexamail Guard archive SMTP email passing through Hexamail Guard
bool
On/Off, True/False, Yes/No, 1/0
off
ArchiveSMTP=off
ArchiveSMTPInbound
Use this setting to have Hexamail Guard archive SMTP inbound email passing through Hexamail Guard
bool
On/Off, True/False, Yes/No, 1/0
on
ArchiveSMTPInbound=on
ArchiveSMTPInternal
Use this setting to have Hexamail Guard archive SMTP internal email passing through Hexamail Guard. Remember that if you are using a mailserver with proprietary protocols such as Exchange or Notes it may not be using SMTP for internal email delivery.
Also remember that internal email sent using webmail clients on some mailservers wont pass thru an external SMTP gateway and may not be collected in this way.
bool
On/Off, True/False, Yes/No, 1/0
on
ArchiveSMTPInternal=on
ArchiveSMTPOutbound
Use this setting to have Hexamail Guard archive SMTP outbound email passing through Hexamail Guard
bool
On/Off, True/False, Yes/No, 1/0
on
ArchiveSMTPOutbound=on
ArchiveSMTPRelay
Use this setting to have Hexamail Guard archive SMTP relay email passing through Hexamail Guard
bool
On/Off, True/False, Yes/No, 1/0
on
ArchiveSMTPRelay=on
ArchiveSMTPDelete
Use this setting to have Hexamail Guard delete SMTP email once it has been processed.
Email will not be delivered to any further server or mailbox for the final recipient.
ONLY use this setting if you are CCing or otherwise replicating email to Hexamail Guard using SMTP.
Do not use this setting if you do not understand the consequences!
bool
On/Off, True/False, Yes/No, 1/0
off
ArchiveSMTPDelete=off
ArchivePST
Use this setting to have Hexamail Guard archive PST files found in the PST directory
bool
On/Off, True/False, Yes/No, 1/0
off
ArchivePST=off
ArchivePSTPath
text
ArchivePSTPath=c:\PSTFolder
ArchivePSTDelete
Use this setting to have Hexamail Guard DELETE all PST files found in the PST directory after indexing
bool
On/Off, True/False, Yes/No, 1/0
off
ArchivePSTDelete=off
ArchivePSTRestrict
Use this setting to have all configured restrictions applied when importing PST files. NOTE mailbox inclusions/exclusions cannot be applied.
bool
On/Off, True/False, Yes/No, 1/0
on
ArchivePSTRestrict=on
ArchiveFoldersInclude
Folders to include in the archive importing.
If you are using Exchange 2010 onwards these will be automatically converted to the correct naming convention when exporting mailboxes from Exchange
text
*
ArchiveFoldersInclude=*
ArchiveFoldersExclude
Folders to exclude from the archive importing.
If you are using Exchange 2010 onwards these will be automatically converted to the correct naming convention when exporting mailboxes from Exchange
Only email that larger than this size will be indexed. Set to 0 to index email of all sizes.
0 KBytes
ArchiveLargerThan=0
ArchiveSmallerThan
Only email that smaller than this size will be indexed. Set to 0 to index email of all sizes.
4000000 KBytes
ArchiveSmallerThan=4000000
ArchiveDaysOldMin
Only email that is older than this number of days will be indexed. Set to 0 to index email of all ages.
0 Days old
ArchiveDaysOldMin=365
ArchiveDaysOldMax
Only email that is newer than this number of days will be indexed. Set to 0 to index email of all ages.
0 Days old
ArchiveDaysOldMax=365
StoreLocation
Where Xifte is installed
text
local
StoreLocation=local
StoreLocation
The archive store 'xifte' is on the local machine
text
on
StoreLocation=on
StoreLocation
The archive store 'xifte' is on another machine
text
off
StoreLocation=off
XifteInstaller
link
Host
text
127.0.0.1
Host=127.0.0.1
BindHost
text
AllowedIPList
This is the list of allowed IP addresses that can connect to your SMTP server. You can use wildcards and ranges (e.g. 192.*.*.*, 192.10-50.*.*) or leave blank for any IP. WARNING: By setting this, connections are restricted to ONLY those that match an entry in this list.
text
127.*.*.*,10.*.*.*,192.*.*.*,::1
AllowedIPList=127.*.*.*,10.*.*.*,192.*.*.*,::1
Port
number
23021
Port=23021
IndexPort
number
23022
IndexPort=23022
QueryPort
number
23023
QueryPort=23023
ExchangeJournalMailbox
NOTE that all email in the journal account will be deleted after being successfully added to the archive.
Enable indexing of historical mail from Exchange mailbox folders
on
ExchangeMailboxes=off
ExchangeJournal
Enable indexing of historical mail from Exchange mailbox folders
off
ExchangeJournal=off
ExchangeDeleteJournal
Enable deletion of mail once it has been indexed from the journal account
on
ExchangeDeleteJournal=off
QueryFlags
You can combine the query fields using AND or OR
select
OR, AND
AND
QueryFlags=AND
QueryTextFlags
Any words
QueryTextFlags=Any words
ExportFileTmpl
The Archive Store server can be made to export files to disk. The extension is added to this automatically depending on your output format setting (txt/eml)
Files are exported on the Archive Store server for efficiency.
The exported email are output using filenames based on this option. The fields you can use are:
<subject> - The email subject
<sndr> - The email sender address (SMTP Sender)
<sndrdomain> - The email sender domain (SMTP Sender)
<direction> - The email direction map (inbound,outbound,relay,internal or some combination)
<from> - The email from address (MIME From)
<rcpt> - The email recipient (first recipient)
<date> - The email date (MIME Date)
<datetime> - The email date and time (MIME Date)
<epoch> - The email date (MIME Date) as seconds since the EPOCH
NOTE: Use <subject-> to have disallowed filename characters in the subject replaced with - instead of the default _
And similarly for other fields.
text
<subject>
ExportFileTmpl=<sndr> - <subject>
ExportPath
The Archive Store server can be made to export files to disk. The path specified is a path on the server to which to export.
Files are exported on the Archive Store server for efficiency.
The exported email are output using pathnames based on this option. If a path does not exist it will be created in its entirity.
The fields you can use are:
<subject> - The email subject
<sndr> - The email sender address (SMTP Sender)
<sndrdomain> - The email sender domain (SMTP Sender)
<direction> - The email direction map (inbound,outbound,relay,internal or some combination)
<from> - The email from address (MIME From)
<rcpt> - The email recipient (first recipient)
<date> - The email date (MIME Date)
<datetime> - The email date and time (MIME Date)
<epoch> - The email date (MIME Date) as seconds since the EPOCH
NOTE: Use <subject-> to have disallowed filename characters in the subject replaced with - instead of the default _
And similarly for other fields.
text
./export/
ExportPath=c:\exportedemail\
ExportZip
The Archive Store server can be made to export files to disk. The path specified is a path on the server to which to export.
Files are exported on the Archive Store server for efficiency.
text
exportedemail.zip
ExportZip=complianceissue1.zip
ExportFormat
The exported email can be output in a number of different formats:
MIME - .eml files containing the full MIME content of the email including all headers txt - .txt files containing most important headers and a textual rendering of the email content
text
MIME
ExportFormat=Text
ExportOutput
The exported email can be output in a directory or a zipfile
text
Zip
ExportOutput=Zip
ResendSubjectPrefix
When you restore email from the archive you can have the subject automatically prefixed to allow the recipient to clearly see that is is from the archive
text
[Archived]
ResendSubjectPrefix=[Restored]
ResendExternal
Normally restored email will only be sent to the original internal recipients, you can optionally redeliver to external recipients as well
bool
On/Off, True/False, Yes/No, 1/0
False
ResendExternal=True
ArchivexName
the name by which you wish to call this archive
text
ArchivexEnable
Enable this archive
bool
On/Off, True/False, Yes/No, 1/0
on
Archive%dEnable=on
ArchivexDescription
description of this archive
text
ArchivexDirections
email in there directions will be matched
flags
InBound
Archive%dDirections=InBound
ArchivexRuleyEnable
Enable this rule
bool
On/Off, True/False, Yes/No, 1/0
on
Archive%dRule%dEnable=on
ArchivexRuleyName
the name by which you wish to call this rule
text
Archive%dRule%dName=Customer email
ArchivexRuleySubjectMatches
email with subjects that match any of these wildcard/phrase/substring will be archived. Leave blank no subject restrictions
text
ArchivexRuleyContentMatches
email with contents that match any of these wildcard/phrase/substring will be archived. Leave blank no content restrictions
text
ArchivexRuleyTimeRange
only email sent between the start and end times will be archived
bool
On/Off, True/False, Yes/No, 1/0
Off
Archive%dRule%dTimeRange=Off
ArchivexRuleyStartTime
only email sent between the start and end times will be archived
text
Archive%dRule%dStartTime=9:00
ArchivexRuleyEndTime
only email sent between the start and end times will be archived
text
Archive%dRule%dEndTime=17:00
ArchivexRuleyDateRange
only email sent between the start and end dates will be archived
bool
On/Off, True/False, Yes/No, 1/0
Off
Archive%dRule%dDateRange=Off
ArchivexRuleyStartDate
only email sent between the start and end dates will be archived
text
NOW
Archive%dRule%dStartDate=12 July 2004
ArchivexRuleyEndDate
only email sent between the start and end dates will be archived
text
NOW
Archive%dRule%dEndDate=27 July 2005
ArchivexRuleyDays
only email sent on a day that match the selected days will be archived
This option will DELETE all email that is exported from the mailbox folders specified.
Use this to export and delete email from a specific folder used for archiving.
This option is disabled if the entire mailbox is to be exported and archived.
off
ExchangeMailboxMailAction=off
ExchangeMailboxMailAction
This option will DELETE all email that is exported from the mailbox folders specified.
Use this to export and delete email from a specific folder used for archiving.
This option is disabled if the entire mailbox is to be exported and archived.
off
ExchangeMailboxMailAction=off
ExchangeMailboxMailAction
This option will MOVE all email that is exported from the mailbox folders specified.
Use this to export and move email from a specific folder used for archiving.
This option is disabled if the entire mailbox is to be exported and archived.
off
ExchangeMailboxMailAction=off
ExchangeMailboxMailMove
Mailbox folder to move email to once exported from Exchange and indexed
ExchangeMailboxMailMove=Backup
ExchangePSTUNCShare
APPLIES TO EXCHANGE 2007, 2010, 2013 ONLY
NOTE that all PST files and other temporary files in this folder created by Hexamail will be deleted after being successfully added to the archive.
EXCHANGE 2010/2013: this path must be a UNC share accessible by the Exchange service and Hexamail service for read and write with the notation \\share\...
EXCHANGE 2007: this path can be any local file system folder accessible by the Exchange service and Hexamail service for read and write.
The folder must be shared with the Local Service account and the Local Service account must have full permissions to modify the folder.
text
ExchangePSTUNCShare=\\ExchangeServer\TempPST
ExchangePSTMoveTo
You can optionally copy the completed PST files to a location as a backup. Clear this setting to not keep copies completed PST files.
text
ExchangePSTMoveTo=d:\pstfiles\
EWSHost
text
localhost
EWSHost=localhost
EWSPort
number
443
EWSPort=443
EWSSSL
bool
On/Off, True/False, Yes/No, 1/0
true
EWSSSL=true
EWSIgnoreSSLCertErrors
Some Exchange servers have expired or self-signed certificates for testing purposes. Use this setting to ignore certificate errors.
true
EWSIgnoreSSLCertErrors=true
EWSUsername
The user you wish to use for communications via EWS. This user should have impersonation permissions set by Powershell.
To allow impersonation on your Exchange server please run this powershell script in the Exchange Powershell console on the server:
[PS] C:\Windows\system32>New-ManagementRoleAssignment -name:HexamailImpersonation -Role:ApplicationImpersonation -User:<username>
For example:
[PS] C:\Windows\system32>New-ManagementRoleAssignment -name:HexamailImpersonation -Role:ApplicationImpersonation -User:Hexamail
or
[PS] C:\Windows\system32>New-ManagementRoleAssignment -name:HexamailImpersonation -Role:ApplicationImpersonation -User:Administrator
Administrator
EWSUsername=Hexamail
EWSPassword
The password used to authenticate for this account
encryptedtext
EWSFolder
The default folder to upload to. This must be a well-known default folder such as "inbox", "sentitems" etc.
Inbox
EWSFolder=Inbox
EWSStubbing
Stubbing is the replacement of older, large email in Exchange mailboxes with a small piece of text or html (a "stub") which has a link to the original email content in the archive.
In this way the storage requirements in Exchange are reduced but all email is still accessible by users from Outlook
off
EWSStubbing=off
EWSStubContent
Stubbing can truncate and summarize the email content as well as removing attachments. Use this setting to truncate the text or html content.
off
EWSStubContent=off
EWSStubAfter
You can choose to stub only email over a certain age. This means that the less used, older, email can be stubbed but the more current email is left untouched.
24
EWSStubAfter=24
EWSStubSize
You can choose to stub only email over a certain size. This means that the smaller email that has little impact on Exchange storage can stay in Exchange. Large email can be stubbed to remove the storage overhead in Exchange.
16
EWSStubSize=16
EWSStubMailboxInclude
text
EWSStubMailboxExclude
text
EWSStubFolderInclude
text
EWSStubFolderExclude
text
EWSStubTemplate
You can customize the stub template used with this editor. Changing this setting will force Hexamail to restub all stubbed email in Exchange.
<!-- HXM_STUBBED Do not remove this tag -->
<div class="hxmsummary"><pre><?HXM_CONTENT?></pre></div>
<table style="border:solid black 1px; background-color:#FEEDD0;" width="100%">
<tr>
<td><h3 style="font-size:0.7em; padding:6px; margin:0px;">Hexamail Archiver Stub</h3></td>
<td><p style="font-size:0.7em;padding:6px;margin:0px;"><a title="View email" href="<?HXM_URL?>">View Email</a></p></td>
<td><p style="font-size:0.7em;padding:6px;margin:0px;"><a title="Restore email" href="<?HXM_URL?>&restore=true&fldr=">Restore Email</a></p></td>
</tr>
</table>
EWSStubTemplate=
<!-- HXM_STUBBED Do not remove this tag -->
<div class="hxmsummary"><pre><?HXM_CONTENT?></pre></div>
<table style="border:solid black 1px; background-color:#FEEDD0;" width="100%">
<tr>
<td><h3 style="font-size:0.7em; padding:6px; margin:0px;">Hexamail Archiver Stub</h3></td>
<td><p style="font-size:0.7em;padding:6px;margin:0px;"><a title="View email" href="<?HXM_URL?>">View Email</a></p></td>
<td><p style="font-size:0.7em;padding:6px;margin:0px;"><a title="Restore email" href="<?HXM_URL?>&restore=true&fldr=">Restore Email</a></p></td>
</tr>
</table>
EWSExpire
You can choose to expire email from user mailboxes in Exchange when it reaches a certain age.
off
EWSExpire=off
EWSExpireAfter
The age at which to expire email from Exchange user mailboxes
60
EWSExpireAfter=60
EWSExpireMailboxInclude
EWSExpireMailboxExclude
EWSExpireFolderInclude
EWSExpireFolderExclude
Alert
Send alert email about archive statistics and disk usage
bool
On/Off, True/False, Yes/No, 1/0
false
Alert=false
AlertSubject
text
Archive Status Report <date> (<total>)
AlertSubject=Archive Status Report <date> (<total>)