Hexamail Guard Configuration Reference [POP3Reader]

[POP3Reader]

The following settings can be used in this section:

Enable
You can turn on/off the entire POP3 Reader module using this switch
bool
On/Off, True/False, Yes/No, 1/0
On
Enable=On
UserAccounts
bool
On/Off, True/False, Yes/No, 1/0
Off
UserAccounts=Off
UserAccountDefaultWebUI
bool
On/Off, True/False, Yes/No, 1/0
Off
UserAccountDefaultWebUI=Off
UserAccountDefaultHost
Each account can be downloaded from a separate server. Be sure to fill in the correct server details for each account. POP3 is usually collected from port 110. If you leave these settings blank, the default server and port settings will be used from the Settings page in the POP3 Reader module. Remember to use the server name not IP if collecting using SSL
text
UserAccountDefaultHost=pop.yourisp.com
UserAccountDefaultPort
Each account can be downloaded from a separate server. Be sure to fill in the correct server details for each account. POP3 is usually collected from port 110. If you leave these settings blank, the default server and port settings will be used from the Settings page in the POP3 Reader module. Remember to use the server name not IP if collecting using SSL
number
110
UserAccountDefaultPort=110
UserAccountDefaultProtocol
text
POP3
UserAccountDefaultProtocol=POP3
UserAccountDefaultSSL
You can optionally specify to use SSL when collecting the email from the account. Check that the server you are collecting from supports SSL before using this setting. If you enable this and the server does not support SSL an error will occur in the log and no email will be collected. Remember to ensure the port setting is correct for SSL POP3 (usually 995 instead of 110), and ensure the server name is specified as a name and not an IP address.
bool
On/Off, True/False, Yes/No, 1/0
false
UserAccountDefaultSSL=false
UserAccountDefaultSchedule
int
30 Minutes
UserAccountDefaultSchedule=30
UserAccountDefaultExpire
int
1 Days
UserAccountDefaultExpire=1
UserAccountDefaultAction
Action to take on email once downloaded
select
Keep, Delete, Expire
Keep
UserAccountDefaultAction=Keep
UserAccountDefaultSizeAction
When a large email is ecountered it can be downloaded, postponed until all other email for the account have been downloaded or skipped altogether (and left on the server).
select
Download, Postpone, Skip
Download
UserAccountDefaultSizeAction=Download
UserAccountDefaultSizeThresh
Email over this size are considered large and will be treated as per the large email action configured
number
1 - 999999 kbytes
2048 kbytes
UserAccountDefaultSizeThresh=2000
Host
Each account can be downloaded from a separate server. Be sure to fill in the correct server details for each account. POP3 is usually collected from port 110. If you leave these settings blank, the default server and port settings will be used from the Settings page in the POP3 Reader module. Remember to use the server name not IP if collecting using SSL
text
Host=pop.yourisp.com
Port
Each account can be downloaded from a separate server. Be sure to fill in the correct server details for each account. POP3 is usually collected from port 110. If you leave these settings blank, the default server and port settings will be used from the Settings page in the POP3 Reader module. Remember to use the server name not IP if collecting using SSL
number
110
Port=110
Protocol
text
POP3
Protocol=POP3
SSL
You can optionally specify to use SSL when collecting the email from the account. Check that the server you are collecting from supports SSL before using this setting. If you enable this and the server does not support SSL an error will occur in the log and no email will be collected. Remember to ensure the port setting is correct for SSL POP3 (usually 995 instead of 110), and ensure the server name is specified as a name and not an IP address.
bool
On/Off, True/False, Yes/No, 1/0
false
SSL=false
Schedule
Each account can be checked for new email on a configurable schedule. Set this to the schedule most appropriate default. Only new email are downloaded each time, so the checks can be as frequent as you like. Remember that some ISPs wont allow collection intervals less than 10-15 minutes. If you set the schedule to be less than your ISP's allowed minimum interval then you may see errors in the log. Contact your ISP if you are unsure what their allowed minimum time interval between collections is and wish to avoid errors in your log or action being taken by your ISP.
number
1 - 2880 minutes
30 minutes
Schedule=30
ScheduleLimit
Each account can be checked for new email on a configurable schedule. Set this to the schedule most appropriate default. Only new email are downloaded each time, so the checks can be as frequent as you like. Remember that some ISPs wont allow collection intervals less than 10-15 minutes. If you set the schedule to be less than your ISP's allowed minimum interval then you may see errors in the log. Contact your ISP if you are unsure what their allowed minimum time interval between collections is and wish to avoid errors in your log or action being taken by your ISP.
number
1 - 2880 minutes
60 minutes
ScheduleLimit=60
ScheduleTimes
List of times for the normal schedule
text
sat14:00,thu10:00,mon22:00,sat19:00,thu15:00,sat03:00,mon11:00,sat08:00,thu04:00,mon16:00,thu09:00,sun20:00,mon00:00,mon05:00,sun14:00,wed20:00,sun19:00,sun03:00,sun08:00,tue22:00,wed14:00,wed19:00,fri21:00,tue11:00,wed03:00,tue16:00,wed08:00,fri10:00,fri15:00,tue00:00,tue05:00,fri04:00,fri09:00,sat23:00,sat12:00,mon20:00,sat17:00,thu13:00,thu18:00,sat01:00,sat06:00,thu02:00,mon14:00,thu07:00,mon19:00,sun23:00,mon03:00,mon08:00,sun12:00,sun17:00,wed23:00,sun01:00,sun06:00,tue20:00,wed12:00,wed17:00,wed01:00,tue14:00,wed06:00,tue19:00,fri13:00,fri18:00,tue03:00,tue08:00,fri02:00,fri07:00,sat21:00,thu22:00,sat10:00,sat15:00,thu11:00,mon23:00,thu16:00,sat04:00,thu00:00,mon12:00,sat09:00,thu05:00,mon17:00,sun21:00,mon01:00,mon06:00,sun10:00,sun15:00,wed21:00,sun04:00,wed10:00,sun09:00,tue23:00,wed15:00,fri22:00,tue12:00,wed04:00,tue17:00,wed09:00,fri11:00,fri16:00,tue01:00,tue06:00,fri00:00,fri05:00,thu20:00,sat13:00,mon21:00,sat18:00,thu14:00,thu19:00,sat02:00,mon10:00,sat07:00,thu03:00,mon15:00,thu08:00,mon04:00,mon09:00,sun13:00,sun18:00,sun02:00,sun07:00,tue21:00,wed13:00,wed18:00,fri20:00,tue10:00,wed02:00,tue15:00,wed07:00,fri14:00,fri19:00,tue04:00,tue09:00,fri03:00,fri08:00,sat22:00,thu23:00,sat11:00,sat16:00,thu12:00,thu17:00,sat00:00,sat05:00,thu01:00,mon13:00,thu06:00,mon18:00,sun22:00,mon02:00,mon07:00,sun11:00,sun16:00,wed22:00,sun00:00,sun05:00,wed11:00,wed16:00,fri23:00,wed00:00,tue13:00,wed05:00,tue18:00,fri12:00,fri17:00,tue02:00,tue07:00,fri01:00,fri06:00,sat20:00,thu21:00
ScheduleTimes=sat14:00,thu10:00,mon22:00,sat19:00,thu15:00,sat03:00,mon11:00,sat08:00,thu04:00,mon16:00,thu09:00,sun20:00,mon00:00,mon05:00,sun14:00,wed20:00,sun19:00,sun03:00,sun08:00,tue22:00,wed14:00,wed19:00,fri21:00,tue11:00,wed03:00,tue16:00,wed08:00,fri10:00,fri15:00,tue00:00,tue05:00,fri04:00,fri09:00,sat23:00,sat12:00,mon20:00,sat17:00,thu13:00,thu18:00,sat01:00,sat06:00,thu02:00,mon14:00,thu07:00,mon19:00,sun23:00,mon03:00,mon08:00,sun12:00,sun17:00,wed23:00,sun01:00,sun06:00,tue20:00,wed12:00,wed17:00,wed01:00,tue14:00,wed06:00,tue19:00,fri13:00,fri18:00,tue03:00,tue08:00,fri02:00,fri07:00,sat21:00,thu22:00,sat10:00,sat15:00,thu11:00,mon23:00,thu16:00,sat04:00,thu00:00,mon12:00,sat09:00,thu05:00,mon17:00,sun21:00,mon01:00,mon06:00,sun10:00,sun15:00,wed21:00,sun04:00,wed10:00,sun09:00,tue23:00,wed15:00,fri22:00,tue12:00,wed04:00,tue17:00,wed09:00,fri11:00,fri16:00,tue01:00,tue06:00,fri00:00,fri05:00,thu20:00,sat13:00,mon21:00,sat18:00,thu14:00,thu19:00,sat02:00,mon10:00,sat07:00,thu03:00,mon15:00,thu08:00,mon04:00,mon09:00,sun13:00,sun18:00,sun02:00,sun07:00,tue21:00,wed13:00,wed18:00,fri20:00,tue10:00,wed02:00,tue15:00,wed07:00,fri14:00,fri19:00,tue04:00,tue09:00,fri03:00,fri08:00,sat22:00,thu23:00,sat11:00,sat16:00,thu12:00,thu17:00,sat00:00,sat05:00,thu01:00,mon13:00,thu06:00,mon18:00,sun22:00,mon02:00,mon07:00,sun11:00,sun16:00,wed22:00,sun00:00,sun05:00,wed11:00,wed16:00,fri23:00,wed00:00,tue13:00,wed05:00,tue18:00,fri12:00,fri17:00,tue02:00,tue07:00,fri01:00,fri06:00,sat20:00,thu21:00
ScheduleLimitTimes
List of times for the limited schedule
text
Action
Once a copy of each message has been downloaded you can choose to keep a copy on the server, delete/remove them from the server immediately, or expire them after the configured time period. If your users are also checking their email directly you may wish to leave them on the server. If not then delete them from the server to save space and prevent the mailbox size being exceeded. Use expiry if you wish to retain them on the server for users to read, but know your users may not remove them from the server either. Remember that expired email will have already been downloaded and forwarded to your emailserver before being expired. In all cases Hexamail Guard keeps track of which messages have been downloaded and only new unseen messages are ever downloaded from the server.
select
Keep, Delete, Expire
Keep
Action=Keep
ExpireTime
The email is expired after this number of days after it is first downloaded/seen by Hexamail on the server
number
1 - 999 Days
1 Days
ExpireTime=1
MaxConnections
You can use a large number of simultaneous connections to provide for large amounts of email traffic being sent. Set this high if there are lots of accounts you wish to read from and you have sufficient bandwidth to handle large numbers of connections simultaneously.
number
1 - 128
6
MaxConnections=12
TimeOut
If the maximum timeout is exceeded the POP3 session is terminated. Any email remaining will be collected next time the POP3 reader connects. You should only need to increase this if you have servers on very poor connections, or extremely busy servers.
number
30 - 9000 seconds
180 seconds
TimeOut=240
MaxDuration
If the maximum duration is exceeded for a single transaction the POP3 session is terminated. Any email remaining will be collected next time the POP3 reader connects. You should not need to modify this unless working with extremely low bandwidth and very large email.
number
600 - 600000 seconds
6000 seconds
MaxDuration=12000
MaxConnectionDuration
This sets the maximum duration one account can use to collect email. After this time the connection will be closed and other accounts checked. Any email remaining will be collected next time the POP3 reader checks the account. This can prevent a few very large accounts saturating the connections and not allowing other accounts to be collected. If you can only make a few connections to your POP or IMAP servers but wish to receive email regularly you may want to decrease this setting
number
1 - 6000 minutes
25 minutes
MaxConnectionDuration=25
MaxConnectionCount
This sets the maximum number of email collected from one account in one connection. After this number the connection will be closed and other accounts checked. Remaining email will be collected next time the POP3 reader checks the account. This can prevent a few very large accounts saturating the connections and not allowing other accounts to be collected. If you can only make a few connections to your POP or IMAP servers but wish to receive email regularly you may want to decrease this setting. Set it to 0 (default) to collect all email
number
0 - 50000 email
0 email
MaxConnectionCount=25
MaxRecvBandwidth
Maximum total bandwidth usage or download rate to use when downloading all accounts
number
1 - 1000000 kbps
1000000 kbps
MaxRecvBandwidth=64
LimitRecvBandwidth
Limited total bandwidth usage or download rate to use when downloading all accounts
number
1 - 1000000 kbps
512 kbps
LimitRecvBandwidth=64
BandwidthLimitTimes
List of times for the limited bandwidth usage
text
MaxSendBandwidth
number
1 - 1000000 kbps
1000000 kbps
MaxSendBandwidth=64
LimitSendBandwidth
number
1 - 1000000 kbps
1000000 kbps
LimitSendBandwidth=64
DiagLog
You can turn on diagnostic logging for all connections with this switch
bool
On/Off, True/False, Yes/No, 1/0
false
DiagLog=false
ErrorAdmin
In case of errors in the downloading of email send an error alert to the Adminsitrator email address
bool
On/Off, True/False, Yes/No, 1/0
false
ErrorAdmin=false
ErrorUser
In case of errors in the downloading of email send an error alert to the email address specified for the User Account or System Account
flags
Authentication
ErrorUser=Authentication
From
Configure the from field you wish to use in your email error alert header
text
<<adminemail>> "Hexamail Guard"
From=<<adminemail>> "Hexamail Guard"
Subject
Configure the subject field you wish to use in your email error alert header
text
Error downloading external account email
Subject=Error downloading external account email
Content
Configure the content you wish to use in your email error alert
text
There was an error downloading the external account email for <email>: <error> (<errornum>) Please correct your settings
Content=There was an error downloading the external account email for <email>: <error> (<errornum>) Please correct your settings
NotifyMin
The minimal interval between notifications
number
1 - 43200 Minutes
1440 Minutes
NotifyMin=1440
BackPressure
If the email in queue (emailin/) exceeds this number of email then back pressure will be applied and accounts will stop downloading until the queue is cleared. Set to zero to turn off this feature.
number
0 - 50000 Stored Email
10000 Stored Email
BackPressure=10000
OutputFileReplaceChar
Character used to replace disallowed characters when outputing email subject etc as filenames
text
_
OutputFileReplaceChar=_
AccountxEnable
bool
On/Off, True/False, Yes/No, 1/0
true
Account%dEnable=true
AccountxType
A catch-all account is a account where email to multiple recipients is delivered. Usually all the recipients are of the same domain, e.g the account will contain email to a@example.com ,b@example.com and c@example.com. If you wish to download all these email and forward them on to your server, use a catch-all account. Catch all accounts preserve the original recipients, so email to a@example.com will be forwarded to a@example.com on your email server. See the 'Reroute email to' setting for information on rerouting catch-all email to other domains.
text
off
Account%dType=off
See Also:AccountxRouteTo
AccountxType
An individual account is used to collect ALL email that are in the account and forward to a FIXED RECIPIENT list on your server. This may be one recipient or multiple, but they are specified in the Reroute to field and not extracted from the downloaded email headers.
text
off
Account%dType=off
AccountxName
Accounts require a username and password login to allow downloading of email. This is the username or login name you provide to access this account and is used by the POP3 reader to automatically login to get your email from this account
text
AccountxEmail
A unique email address associated with this account used to identify this account. Typically this should be the email address of the account you are collecting, so if you are collecting email from an ISP this could be for example myuser@myisp.com
text
AccountxDomain
The domains associated with this account. This is used to catch all email that have recipients matching these domains. If example.com is specified (or *@example.com or @example.com) then any email with recipients at that domain will be forwarded to that recipient on your email server. So an email with recipients a@example.com and b@somewhereelse.com will be sent to your email server for delivery to a@example.com. You can specify multiple domains to catch using comma separated entries e.g abc.com, abc.co.uk
text
See Also:AccountxRouteTo
AccountxSenderFromWhen
Always will always use the From address as the sender address when present. First, Second, Third, Fourth allows you to prioritize this header for use as the SMTP sender address. For example all those set to First will be checked first and the sender used if a valid address is found. Then the second fields will be checked and used if present. Last Resort will only use sender from this field if no others have been found.
text
Second
Account%dSenderFromWhen=Second
AccountxSenderReturnPathWhen
Always will always use the Return path address as the sender address when present. First, Second, Third, Fourth allows you to prioritize this header for use as the SMTP sender address. For example all those set to First will be checked first and the sender used if a valid address is found. Then the second fields will be checked and used if present. Last Resort will only use sender from this field if no others have been found.
text
First
Account%dSenderReturnPathWhen=First
AccountxSenderCustomWhen
Always will always use the custom field address as the sender address when present. First, Second, Third, Fourth allows you to prioritize this header for use as the SMTP sender address. For example all those set to First will be checked first and the sender used if a valid address is found. Then the second fields will be checked and used if present. Last Resort will only use sender from this field if no others have been found.
text
Never
Account%dSenderCustomWhen=Never
AccountxSenderCustom
text
AccountxSender
You can override the sender address used for missing senders using this setting. Some email will have no suitable MIME addresses for the sender. The default behaviour is to use POP3_<account name/email> as the address. Use this setting to specify your own sender address to use when no From MIME field is available. NOTE: using an internal/local address may stop the email being processed for SPAM etc. The address should be a valid address external to your domain, which is not allowlisted. Specify NONE to use a blank sender when sending the email on the next hop, if your server supports this. This setting only controls the SMTP envelope sender address and will not affect replies to the email or the displayed From field in email clients
text
AccountxSenderForce
You can override the sender address used for ALL email using this setting. Note that the reply-to and displayed From field shown to recipients of the email will not be affected. This setting only controls the SMTP envelope sender address
bool
On/Off, True/False, Yes/No, 1/0
off
Account%dSenderForce=off
AccountxFrom
You can override the displayed From address (MIME From field) shown to recipients of the email. This will change the displayed From address and Reply-To address that the final recipients of the email will see in their email client.
text
AccountxPassword
Accounts require a username and password login to allow downloading of email. This is the password you provide to access this account and is used by the POP3 reader to automatically login to get your email from this account
encryptedtext
AccountxAuthType
Most accounts require simple password authentication. If you are using Gmail, google mail, Office365 or Outlook.com you can use password authentication with either Legacy App access or App-passwords.
text
true
Account%dAuthType=true
AccountxAuthType
Google, Google Apps, Gmail, Office365 and Outlook.com accounts can require OAuth2 authentication. Use this option to use OAuth2 instead of App-password or legacy password authenticaton.
text
off
Account%dAuthType=off
AccountxOAuthButton
Sets up OAuth authentication for the account. If you are downloading from a hosted cloud email service such as Gmail or Office365 you may need to choose OAuth2 authentication, and click the authenticate button to sign in and get an authentication token.
text
AccountxOAuthToken
Stores the OAuth2 authentication token
text
AccountxOAuthADType
Stores the OAuth2 authentication type
text
AccountxOAuthState
Stores the OAuth2 authentication state
text
AccountxOAuthExpiry
Stores the OAuth2 authentication expiry time
number
AccountxUseAPOP
APOP (Authenticated Post Office Protocol) ensures that your password is not sent in clear text to the server. The server needs to support APOP to use this feature
bool
On/Off, True/False, Yes/No, 1/0
false
Account%dUseAPOP=false
AccountxUseSSL
You can optionally specify to use SSL when collecting the email from the account. Check that the server you are collecting from supports SSL before using this setting. If you enable this and the server does not support SSL an error will occur in the log and no email will be collected. Remember to ensure the port setting is correct for SSL POP3 (usually 995 instead of 110), and ensure the server name is specified as a name and not an IP address.
bool
On/Off, True/False, Yes/No, 1/0
false
Account%dUseSSL=false
AccountxSSLIgnoreCertErrors
Ignore certificate errors when connecting using SSL
bool
On/Off, True/False, Yes/No, 1/0
On
Account%dSSLIgnoreCertErrors=On
AccountxSSLOpenSSL
This will use the OpenSSL encryption system instead of Windows SSPI. Sometimes this can help work around SSL incompatibilies with older Windows versions connecting to newer servers. For example Windows 2003 servers can have missing Cryptographic cipher sets required by newer servers. Rather than trying to install all the required hotfixes and change the Windows Cipher set settings (registry entries) it can sometimes be quicker to just use OpenSSL instead
bool
On/Off, True/False, Yes/No, 1/0
Off
Account%dSSLOpenSSL=Off
AccountxUseDeliveredTo
If checked, the Delivered-To headers will be checked for valid recipients to route email to in addition to the other fields. Some pop servers setup these headers with the actual recipients the email was delivered to.
bool
On/Off, True/False, Yes/No, 1/0
false
Account%dUseDeliveredTo=false
AccountxUseDeliveredToWhen
Always will always include the recipients for the email from this field. First, Second, Third, Fourth allows you to prioritize this header for recipient collection. For example all those set to First will be checked first and all recipients collected from ALL those set to First. Then the second fields will be checked and recipients gathered. Last Resort will only include recipients from this field if no others have been found.
text
Always
Account%dUseDeliveredToWhen=Always
AccountxUseEnvelopeTo
If checked, the Envelope-To headers will be checked for valid recipients to route email to in addition to the other fields. Some pop servers setup these headers with the actual recipients the email was delivered to.
bool
On/Off, True/False, Yes/No, 1/0
false
Account%dUseEnvelopeTo=false
AccountxUseEnvelopeToWhen
Always will always include the recipients for the email from this field. First, Second, Third, Fourth allows you to prioritize this header for recipient collection. For example all those set to First will be checked first and all recipients collected from ALL those set to First. Then the second fields will be checked and recipients gathered. Last Resort will only include recipients from this field if no others have been found.
text
Always
Account%dUseEnvelopeToWhen=Always
AccountxExcludeAddresses
Specify email addresses to exclude from the recipients list
text
AccountxUseTo
If checked, the To, Cc and Bcc headers will be checked for valid recipients to route email to in addition to the other fields selected
bool
On/Off, True/False, Yes/No, 1/0
true
Account%dUseTo=true
AccountxUseToWhen
Always will always include the recipients for the email from this field. First, Second, Third, Fourth allows you to prioritize this header for recipient collection. For example all those set to First will be checked first and all recipients collected from ALL those set to First. Then the second fields will be checked and recipients gathered. Last Resort will only include recipients from this field if no others have been found.
text
Always
Account%dUseToWhen=Always
AccountxUseCCBCC
If checked, the To, Cc and Bcc headers will be checked for valid recipients to route email to in addition to the other fields selected
bool
On/Off, True/False, Yes/No, 1/0
true
Account%dUseCCBCC=true
AccountxUseCCBCCWhen
Always will always include the recipients for the email from this field. First, Second, Third, Fourth allows you to prioritize this header for recipient collection. For example all those set to First will be checked first and all recipients collected from ALL those set to First. Then the second fields will be checked and recipients gathered. Last Resort will only include recipients from this field if no others have been found.
text
Always
Account%dUseCCBCCWhen=Always
AccountxUseReceived
If checked, recipients will be extracted from the Received: ... for... headers of the email
bool
On/Off, True/False, Yes/No, 1/0
true
Account%dUseReceived=true
AccountxUseReceivedWhen
Always will always include the recipients for the email from this field. First, Second, Third, Fourth allows you to prioritize this header for recipient collection. For example all those set to First will be checked first and all recipients collected from ALL those set to First. Then the second fields will be checked and recipients gathered. Last Resort will only include recipients from this field if no others have been found.
text
Last Resort
Account%dUseReceivedWhen=Last Resort
AccountxHost
text
Account%dHost=pop.yourisp.com
AccountxPort
number
110
Account%dPort=110
AccountxProt
text
POP3
Account%dProt=POP3
AccountxDiagLog
You can turn on diagnostic logging with this switch
bool
On/Off, True/False, Yes/No, 1/0
false
Account%dDiagLog=false
AccountxFolders
For IMAP accounts you can configure multiple folders to download. NOTE: The POP3 protocol only allows the download of the INBOX, so you must use an IMAP account to use this feature
text
INBOX
Account%dFolders=*
AccountxFoldersSkip
For IMAP accounts you can configure multiple folders to skip. NOTE: The POP3 protocol only allows the download of the INBOX, so you must use an IMAP account to use this feature Skipping * will be ignored as the account would not download any email.
text
*Deleted*,*Trash*,*Junk*,*Spam*,*supprim*,*Outbox*,*Gelöschte Elemente*,*Papierkorb*
Account%dFoldersSkip=Drafts
AccountxUseIDLE
For IMAP accounts you can use IDLE time notifications to trigger download of new messages. This can only be used for IMAP accounts with one folder configured. Using this feature means a permanent connection will be used for each IMAP account with this setting enabled. Please be sure to raise your maximum connections setting to provide adequate connections for all your IMAP accounts that have this feature enabled. NOTE: The POP3 protocol does not support this feature
text
Off
Account%dUseIDLE=Off
AccountxIDLEPeriod
For IMAP accounts you can use IDLE time notifications to trigger download of new messages. Some servers require that you limit the IDLE time to prevent timeouts in your connection to the server. Use this setting to stop and restart the IDLE to ensure the server does not time out your connection. NOTE: The POP3 protocol does not support this feature
text
29 minutes
Account%dIDLEPeriod=29
AccountxFolderTag
You can optionally insert an email header specifying the origin folder of the email
bool
On/Off, True/False, Yes/No, 1/0
on
Account%dFolderTag=on
AccountxFolderTagField
You can optionally insert an email header specifying the origin folder of the email
text
X-HXM-Folder
Account%dFolderTagField=X-HXM-Folder
AccountxIMAPSeen
You can optionally set email as read when downloaded using IMAP. NOTE: POP3 does not support the concept of read/unread flags so this only applies to IMAP
text
true
Account%dIMAPSeen=true
AccountxIMAPDateStart
You can optionally download only email newer than this number of days. Use 0 days to ignore this setting
text
0
Account%dIMAPDateStart=0
AccountxIMAPDateEnd
You can optionally download only email older than this number of days. Use 0 days to ignore this setting
text
0
Account%dIMAPDateEnd=0
AccountxFolderSkipGmail
You can optionally skip the GMAIL special folders that duplicate email from other folders. These are the folders stored under the IMAP path [Gmail] and are used to represent label information and other attributes. If you choose to download these folders as well from a Gmail accouint you may end up with duplicate email.
text
true
Account%dFolderSkipGmail=true
AccountxSchedule
Each account can be checked for new email on a configurable schedule. Set this to the schedule most appropriate for each account. Only new email are downloaded each time, so the checks can be as frequent as you like. Remember that some ISPs wont allow collection intervals less than 10-15 minutes. If you set the schedule to be less than your ISP's allowed minimum interval then you may see errors in the log. Contact your ISP if you are unsure what their allowed minimum time interval between collections is and wish to avoid errors in your log or action being taken by your ISP.
number
1 - 2880 minutes
30 minutes
Account%dSchedule=30
AccountxScheduleLimit
Each account can be checked for new email on a configurable schedule. Set this to the schedule most appropriate for each account. Only new email are downloaded each time, so the checks can be as frequent as you like. Remember that some ISPs wont allow collection intervals less than 10-15 minutes. If you set the schedule to be less than your ISP's allowed minimum interval then you may see errors in the log. Contact your ISP if you are unsure what their allowed minimum time interval between collections is and wish to avoid errors in your log or action being taken by your ISP.
number
1 - 2880 minutes
5 minutes
Account%dScheduleLimit=5
AccountxScheduleTimes
List of times for the normal schedule
text
AccountxScheduleLimitTimes
List of times for the limited schedule
text
AccountxRouteTo
You can specify one recipient email address (example@domain.com), or multiple using a comma to separate the addresses (example1@domain.com,example2@domain.com). Use *@newdomain.com to reroute all catch all email to a new domain e.g. user1@ispdomain.com -> user1@newdomain.com and user2@ispdomain.com -> user2@newdomain.com Use <localpart>_example@newdomain.com to reroute all catch all email to a new domain e.g. user1@ispdomain.com -> user1_example@newdomain.com and user2@ispdomain.com -> user2_example@newdomain.com
text
Account%dRouteTo=myuser@domain.local,<localpart>@localdomain.com,*@anotherdomain.com
AccountxRecipientRoutes
You can configure Hexamail Guard to reroute email for specific recipients to new recipient(s)
text
Account%dRecipientRoutes=abc@ispdomain.com:abc1@localdomain.com,abc2@localdomain.com xyz@ispdomain.com:abc3@localdomain.com 123*@ispdomain.com:abc1@localdomain.com *@anotherdomain.com:user1@localdomain.com user2@*domain.com:user2@localdomain.com
AccountxSenderRoutes
You can configure Hexamail Guard to reroute email for specific senders to new recipient(s)
text
Account%dSenderRoutes=sender1@ispdomain.com:abc1@localdomain.com,abc2@localdomain.com sender2@ispdomain.com:abc3@localdomain.com sender123*@ispdomain.com:abc1@localdomain.com *@anotherdomain.com:user1@localdomain.com sender4@*domain.com:user2@localdomain.com
AccountxSubjectRoutes
You can configure Hexamail Guard to reroute email for specific subject matches to new recipient(s)
text
Account%dSubjectRoutes=*News*:news@localdomain.com,info@localdomain.com *Order*:orders@localdomain.com *Payment*:orders@localdomain.com
AccountxAction
Once a copy of each message has been downloaded you can choose to keep a copy on the server, delete/remove them from the server immediately, or expire them after the configured time period. If your users are also checking their email directly you may wish to leave them on the server. If not then delete them from the server to save space and prevent the mailbox size being exceeded. Use expiry if you wish to retain them on the server for users to read, but know your users may not remove them from the server either. Remember that expired email will have already been downloaded and forwarded to your emailserver before being expired. In all cases Hexamail Guard keeps track of which messages have been downloaded and only new unseen messages are ever downloaded from the server.
select
Keep, Delete, Expire
Keep
Account%dAction=Keep
AccountxExpireTime
Days after which to expire email
number
1 - 999 Days
1 Days
Account%dExpireTime=1
AccountxStartupMode
The first time this account connects it can be made to download and forward all existing email or just ones that arrive after the first connection is made.
select
All, New
All
Account%dStartupMode=All
AccountxPersistantIDCache
Retain previous ID cache if no new IDs are found. The ID cache will be retained until a new list can be downloaded from the server.
bool
On/Off, True/False, Yes/No, 1/0
Off
Account%dPersistantIDCache=Off
AccountxDedupMsgID
To prevent duplicate email being downloaded if the server changes its unique ID for email, Hexamail stores the Message-ID of all downloaded email. Use this setting to instruct Hexamail to deduplicate email by Message-ID headers.
bool
On/Off, True/False, Yes/No, 1/0
On
Account%dDedupMsgID=On
AccountxDelDups
To prevent duplicate email being downloaded if the server changes its unique ID for email, Hexamail stores the Message-ID of all downloaded email. By default Hexamail will never delete an email that has not been downloaded and sent to the next server. Use this option to remove email with duplicate Message-IDs from the server even when Hexamail skips downloading the duplicate messages.
bool
On/Off, True/False, Yes/No, 1/0
On
Account%dDelDups=On
AccountxSizeAction
When a large email is ecountered it can be downloaded, postponed until all other email for the account have been downloaded or skipped altogether (and left on the server).
select
Download, Postpone, Skip
Download
Account%dSizeAction=Download
AccountxSizeThresh
Email over this size are considered large and will be treated as per the large email action configured
number
1 - 999999 kbytes
2048 kbytes
Account%dSizeThresh=2000
AccountxHeaderField
When fetching email for multiple recipients from one account, using 'catch-all', you can specify what MIME header field indicates the email address of the recipient. The MIME headers To: CC: and BCC: will automatically be used to find recipients, this setting allows an additional field to be scanned.
text
x-rcpt-to,resent-to,x-resent-to,rcpt-to,x-real-to,x-lyris,x-delivered-to,x-mailscanner-to,resent-bcc,envelope-to,x-envelope-to,resent-cc,x-recipient,x-xs4all-to,x-rcpt-original,x-originally-to,x-mdaemon-deliver-to,original-recipient,x-webde-forward,x-original-to,x-to,x-apparently-to,x-maulhub-apparently-to
Account%dHeaderField=x-rcpt-to,resent-to,x-resent-to,rcpt-to,x-real-to,x-lyris,x-delivered-to,x-mailscanner-to,resent-bcc,envelope-to,x-envelope-to,resent-cc,x-recipient,x-xs4all-to,x-rcpt-original,x-originally-to,x-mdaemon-deliver-to,original-recipient,x-webde-forward,x-original-to,x-to,x-apparently-to,x-maulhub-apparently-to
AccountxHeaderFieldCollect
When gathering recipient email address information from custom headers this can be used to collect addresses from multiple instances of the header.
bool
On/Off, True/False, Yes/No, 1/0
AccountxRestrictRecipient
You can ensure that only valid, listed internal recipients may receive inbound email. This includes all email addresses configured for users, their alias, groups, routes and responders.
bool
On/Off, True/False, Yes/No, 1/0
off
Account%dRestrictRecipient=off
See Also:Users
AccountxUnresolvedForwardTo
When using catch all mailboxes, sometimes recipients cannot be found from the To, CC or BCC headers. In this case the email can be sent to the specified address
text
Account%dUnresolvedForwardTo=admin@domain.local
AccountxUnresolvedDelete
When using catch all mailboxes, if no valid recipients have been extracted according to your configured rules the email will be dropped instead of forwarded. If you have set the account to expire or delete it will also be deleted from the source server. If you have a setting for "Forward unresolved email to" the email will always have a valid recipient. If you choose "Only route to valid user, group, route or responder addresses" then recipients that are not in the described lists will be removed and if this results in no recipients on the email then the entire email will be dropped (not forwarded)
AccountxDisplayRecipient
You can optionally add the rerouted recipients to the displayed email header
bool
On/Off, True/False, Yes/No, 1/0
off
Account%dDisplayRecipient=off
AccountxRemoveTo
You can optionally remove all previous recipients displayed in the email
bool
On/Off, True/False, Yes/No, 1/0
off
Account%dRemoveTo=off
AccountxStripStart
Use this setting to remove any unrequired text from the start of addresses. For example some servers put 1- at the start of all email addresses, specifying 1- here will remove this and leave the corrected address
text
Account%dStripStart=1-
AccountxStripEnd
Use this setting to remove any unrequired text from the end of addresses.
text
Account%dStripEnd=.com
AccountxOutputForward
Use this setting to forward email on to your mailboxes on your configured server or smarthost
bool
On/Off, True/False, Yes/No, 1/0
On
Account%dOutputForward=On
AccountxOutputFile
Use this setting to output email to files in a folder on your local disk.
bool
On/Off, True/False, Yes/No, 1/0
Off
Account%dOutputFile=Off
AccountxOutputFileFolder
Use this setting to choose an output folder on your local disk. Ensure you have sufficient disk space and that some other mechanism is available for removing the files. Hexamail Guard will continue to output files to the specified directory while the file output setting is engaged. The replacement 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)
<dateical> - The email date and time (MIME Date) in ICAL format YYYYMMDDTHHMMSS
<folder> - The folder path the email was downloaded from (IMAP)
<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.
./export/
Account%dOutputFileFolder=./export/
AccountxOutputFileFormat
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
Account%dOutputFileFormat=Text
AccountxOutputFileName
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)
<dateical> - The email date and time (MIME Date) in ICAL format YYYYMMDDTHHMMSS
<folder> - The folder path the email was downloaded from (IMAP)
<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>
Account%dOutputFileName=<date>-<sender>-<subject>
AccountxOutputFileNameLen
The exported email are output using filenames and this setting can control the maximum filename length
number
5 - 1024 characters
128 characters
Account%dOutputFileNameLen=50
AccountxOutputAttach
Use this setting to output email attachments to files in a folder on your local disk.
bool
On/Off, True/False, Yes/No, 1/0
Off
Account%dOutputAttach=Off
AccountxOutputLinks
Use this setting to output links to the file attachments at the end of the text file output
bool
On/Off, True/False, Yes/No, 1/0
Off
Account%dOutputLinks=Off
AccountxOutputAttachMatching
Only attachment files matching one of the configured wild card entries will be output
*.*
Account%dOutputAttachMatching=*.jpg,*.png,*.tiff,img*.jpg
AccountxOutputAttachFileFolder
Use this setting to choose an output folder on your local disk for attachments Ensure you have sufficient disk space and that some other mechanism is available for removing the files. Hexamail Guard will continue to output files to the specified directory while the file output setting is engaged.
./attachments/
Account%dOutputAttachFileFolder=./attachments/
AccountxOutputAttachFileNameNumber
add index number to filenames if already exist
bool
On/Off, True/False, Yes/No, 1/0
on
Account%dOutputAttachFileNameNumber=on
AccountxOutputAttachUnzip
Unzip compressed attachments
bool
On/Off, True/False, Yes/No, 1/0
off
Account%dOutputAttachUnzip=off
AccountxOutputAttachFileName
The exported email attachments are output using filenames based on this option. the fields you can use are:
<attach.ext> - The attachment filename with extension
<attach> - The attachment filename with no extension
<ext> - The attachment filename extension
<subject> - The email subject
<sndr> - The email sender address (SMTP Sender)
<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
<attach.ext>
Account%dOutputAttachFileName=<date>-<sender>-<subject>-<attach.ext>
AccountxOutputAttachFileNameLen
The exported email attachments are output using filenames and this setting can control the maximum filename length
number
5 - 1024 characters
128 characters
Account%dOutputAttachFileNameLen=50
AccountxDebugConnection
bool
On/Off, True/False, Yes/No, 1/0
Off
Account%dDebugConnection=Off