Difference between revisions of "MMP Reference"

From Messaging Server Technical Reference Wiki
Jump to: navigation, search
m (Bulk update)
m (Bulk update)
 
Line 70: Line 70:
 
<dt>[[maxthreads Option|<span id="maxthreads">maxthreads</span>]]<dd>
 
<dt>[[maxthreads Option|<span id="maxthreads">maxthreads</span>]]<dd>
 
<p> The <code>maxthreads</code> MMP option specifies the  maximum number of threads allowed per server process for the selected server.  The MMP does not count worker threads attempting to lookup or connect to a back-end server against this limit; see the separate [[#maxconcurrentconnectionattempts|<code>maxconcurrentconnectionattempts</code>]] option to limit such connections. </p><p>''Introduced to MMP in release: 7 Update 3''</p><p>Unified Config: mmp</p><p>Legacy config file(s):  <code>AService.cfg</code></p><p>The default value is: <code>250</code></p>
 
<p> The <code>maxthreads</code> MMP option specifies the  maximum number of threads allowed per server process for the selected server.  The MMP does not count worker threads attempting to lookup or connect to a back-end server against this limit; see the separate [[#maxconcurrentconnectionattempts|<code>maxconcurrentconnectionattempts</code>]] option to limit such connections. </p><p>''Introduced to MMP in release: 7 Update 3''</p><p>Unified Config: mmp</p><p>Legacy config file(s):  <code>AService.cfg</code></p><p>The default value is: <code>250</code></p>
 +
<dt>[[memcached_enable Option|<span id="memcached_enable">memcached_enable</span>]]<dd>Badguy info will be stored in memached <br/>For more information see [[memcached_enable Option]].<p>''Introduced in release: future''</p><p>Unified Config: mmp</p><p>The default value is: <code>0</code></p>
 +
<dt>[[memcached_host Option|<span id="memcached_host">memcached_host</span>]]<dd>memcached server host name<br/>For more information see [[memcached_host Option]].<p>''Introduced in release: future''</p><p>Unified Config: mmp</p>
 +
<dt>[[memcached_port Option|<span id="memcached_port">memcached_port</span>]]<dd>memcached listening port<br/>For more information see [[memcached_port Option]].<p>''Introduced in release: future''</p><p>Unified Config: mmp</p><p>The default value is: <code>11211</code></p>
 
<dt>[[numprocesses Option|<span id="numprocesses">numprocesses</span>]]<dd>Number of processes for the relevant service<br/>For more information see [[numprocesses Option]].<p>''Introduced to MMP in release: 7 Update 4 patch 25''</p><p>Unified Config: mmp</p><p>configutil: service.mmp.numprocesses</p><p>The default value is: <code>1</code></p>
 
<dt>[[numprocesses Option|<span id="numprocesses">numprocesses</span>]]<dd>Number of processes for the relevant service<br/>For more information see [[numprocesses Option]].<p>''Introduced to MMP in release: 7 Update 4 patch 25''</p><p>Unified Config: mmp</p><p>configutil: service.mmp.numprocesses</p><p>The default value is: <code>1</code></p>
 
<dt>[[plaintextmincipher Option|<span id="plaintextmincipher">plaintextmincipher</span>]]<dd>
 
<dt>[[plaintextmincipher Option|<span id="plaintextmincipher">plaintextmincipher</span>]]<dd>

Latest revision as of 13:40, 10 October 2019


adminpolicy
Policy the MMP uses to determine proxy admin
For more information see adminpolicy Option.

Introduced in release: 8.0.2.1

Unified Config: mmp

The default value is: simple

store.admins
List of user ids with store admin privileges
For more information see admins Option.

Unified Config: store

configutil: store.admins

The default value is: admin

base.authcachesize
Maximum number of users/entries in the authentication cache
For more information see authcachesize Option.

Unified Config: base

configutil: service.authcachesize

The default value is: 10000

authcachettl (seconds)
Length of time an authentication cache entry is valid
For more information see authcachettl Option.

Unified Config: base mmp imapproxy popproxy vdomain

configutil: service.authcachettl

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

The default value is: 900

authenticationldapattributes

The authenticationldapattributes  Auth option specifies a space-separated list of additional LDAP user attributes to look up and pass to the third-party authentication server. This option is also available at imapproxy, popproxy, and vdomain level (to override, for the respective lookups, the general Auth option). To enable support for a third-party authentication server, set the authenticationserver option. For developer instructions and SDK see the directory msg_svr_base/examples/tpauth.

Unified Config: imapproxy popproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

authenticationserver
Host name and port for third-party authentication service
For more information see authenticationserver Option.

Unified Config: imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

authservice
Enable XQUERYAUTH POP command (enable POP before SMTP)
For more information see authservice Option.

Unified Config: popproxy vdomain

Legacy config file(s): PopProxyAService.cfg vdmap.cfg

The default value is: 0

authservicettl (seconds)
Time (seconds) to remember IP source for POP before SMTP
For more information see authservicettl Option.

Unified Config: popproxy vdomain

Legacy config file(s): PopProxyAService.cfg vdmap.cfg

The default value is: -1

backsideport
MMP connects to specified port on Message Store
For more information see backsideport Option.

Unified Config: imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value for the imapproxy is: 143

The default value for the popproxy is: 110

The banner MMP option specifies a banner replacement string. The MMP will use the string you specify for its greeting line. The default banner string contains the software name and version information:

Messaging Multiplexor (<em>product-name version number</em>bit (built <em>build-date</em>))

Unified Config: mmp imapproxy popproxy submitproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

bgdecay (seconds)
Time before forgiving a "bad guy"
For more information see bgdecay Option.

Unified Config: base mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 900

bgexcluded
IP/mask pairs not subject to "bad guy" penalization
For more information see bgexcluded Option.

Unified Config: base mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

bglinear
Select form of "bad guy" penalty decay
For more information see bglinear Option.

Unified Config: base mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 0

bgmax
Maximum number of "bad guy" IP addresses to track
For more information see bgmax Option.

Unified Config: base mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 10000

bgmaxbadness (seconds)
Maximum delay to impose on "bad guy" authentication failures
For more information see bgmaxbadness Option.

Unified Config: base mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 60

bgpenalty (seconds)
Delay to impose on "bad guy" authentication failures
For more information see bgpenalty Option.

Unified Config: base mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 2

binddn
DEPRECATED: Consider using ugldapbinddn and ugldapbindcred
For more information see binddn Option.

Deprecated in release: 7.0.5

Unified Config: imapproxy popproxy submitproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg vdmap.cfg

bindpass
DEPRECATED: Consider using ugldapbinddn and ugldapbindcred
For more information see bindpass Option.

Deprecated in release: 7.0.5

Unified Config: imapproxy popproxy submitproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg vdmap.cfg

canonicalvirtualdomaindelim
Canonical virtual domain delimiter
For more information see canonicalvirtualdomaindelim Option.

Unified Config: mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: @

capability
MMP's IMAP Capability advertisement
For more information see capability Option.

Updated in release: 8.0

Unified Config: imapproxy

Legacy config file(s): ImapProxyAService.cfg

The default value is: IMAP4rev1 ACL RIGHTS=tekx QUOTA LITERAL+ NAMESPACE UIDPLUS CHILDREN BINARY UNSELECT SORT CATENATE URLAUTH ESEARCH ESORT THREAD=ORDEREDSUBJECT THREAD=REFERENCES ENABLE CONDSTORE QRESYNC CONTEXT=SEARCH CONTEXT=SORT WITHIN SASL-IR SEARCHRES METADATA ID LIST-STATUS SPECIAL-USE CREATE-SPECIAL-USE ANNOTATE-EXPERIMENT-1 MULTISEARCH IDLE

connecttimeout (seconds)

The connecttimeout MMP option specifies how long the MMP should wait for a connection to be established to a back-end mailstore (seconds).

Introduced to MMP in release: 7 Update 3

Unified Config: mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 30

connlimits
Max # of connections permitted from IP realm to server
For more information see connlimits Option.

Unified Config: mmp imapproxy popproxy submitproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

connrejectthreshold
Simultaneous connections to accept
For more information see connrejectthreshold Option.

Unified Config: mmp

Legacy config file(s): AService.cfg

crams
Whether to enable crams such as APOP and CRAM-MD5
For more information see crams Option.

Unified Config: mmp imapproxy popproxy vdomain

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

The default value is: 0

base.dcroot
Root of the DC tree in the Directory Server
For more information see dcroot Option.

Unified Config: base

configutil: service.dcroot

debugkeys

The debugkeys option (available under base, mmp, imapproxy, popproxy, and vdomain) specifies a space-separated list of keywords used to enable various optional debugging facilities. Currently recognized keywords are listed in the table below.

KeywordFunction
archive log diagnostics for imapd archiving interface
authserv log auth server protocol communications (new in 7.0.5)
bind log additional details about some TCP socket bind attempts
certmap log debug-level details about certificate mapping operations used for client certificate authentication (new in 7.0.5)
connect log additional details about some TCP connection attempts (more coverage in 7.0.5)
dkim diagnostics for built-in DKIM signing (new in 8.1.0.1)
dkimsig perform an extra sanity check for built-in DKIM signing (new in 8.1.0.1) that is slower but may produce better diagnostics.
dkhash log information about exactly how the DKIM hash is computed, including message content (may have privacy concerns).
dkimkey log parsed DKIM private keys used for signing (may have privacy concerns).
dnsrbl diagnostics for MMP DNS RBL function in main MMP log file (new in 8.0.2.3)
enssub enable logging of ENS subscribe/unsubscribe events at notice level (new in 8.0)
gdisp help diagnose generic dispatcher API issues
gdwork GDisp worker thread information
gdcvar GDisp condition variables (not presently used by the MMP).
eventloop Log GDisp event loop statistics. May be helpful to diagnose performance problems (new in 8.0.2.2).
http Log http transcripts related to Elasticsearch and ISC. (new in 8.0.2.2).
hula log state changes in HULA (user lookup / authentication, new in 7.0.5)
ldap log an LDAP directory protocol trace (replaces the now deprecated ldaptrace base option)
lpool log ldap connection activity (mostly INFO & DEBUG level, new in 7.0.5); for MTA output, see also the os_debug MTA option
maparse Diagnostics for IMAP mail access parser (new in 8.0). The set of IMAP commands this covers presently includes APPEND, STORE, SETMETADATA, SEARCH, ESEARCH, SORT, THREAD. Additional commands will be added over time. This is refreshable.
metermaid log transcript of metermaid client used to limit IMAP password expiration alerts (new in 7.0.5)
perf log performance-related timestamps particularly with respect to MMP authentication
search log IMAP search and sort command processing at DEBUG level (new in 7.0.5)
tls enable additional SSL/TLS debugging (presently just lists active cipher suites in the MMP log)
unicodembox enable debugging for unicode normalization of mailbox names (new in MS 8.0.2)

Updated in release: 8.0.2.2

Unified Config: base mmp imapproxy popproxy submitproxy vdomain

configutil: local.debugkeys

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

defaultdomain

When POP, IMAP and SMTP users authenticate, they typically provide an unqualified user ID (a user ID without a domain portion). The value of the defaultdomain option is appended to unqualified user IDs. When used as an MMP virtual domain option, this allows a single MMP server with multiple IP addresses to support unqualified user IDs for multiple hosted domains. This may also be set as a service-wide option.

Unified Config: base mmp imapproxy popproxy submitproxy vdomain

configutil: service.defaultdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg vdmap.cfg

dnsrbl
Use DNS RBL for MMP IMAP/POP clients
For more information see dnsrbl Option.

Introduced in release: 8.0.2.1

Unified Config: mmp imapproxy popproxy

domainallowed
TCP wrapper Allow filter
For more information see domainallowed Option.

Unified Config: imapproxy popproxy submitproxy

domainnotallowed
TCP wrapper Deny filter
For more information see domainnotallowed Option.

Unified Config: imapproxy popproxy submitproxy

domainsearchformat
A string used constructing LDAP query for user's mail host
For more information see domainsearchformat Option.

Unified Config: mmp imapproxy popproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

The default value is: (uid=%U)

enable

The enable MMP option enables the MMP service on start-msg startup. The default if this option is not set is 0, but initial configuration may set the option to enable the MMP, as appropriate.

To actually run a proxy server, note that the proxy server must have a tcp_listen block defined with at least one non-zero port specified within that block; see in particular the tcp_ports and ssl_ports tcp_listen block options.

Unified Config: mmp

configutil: local.mmp.enable

The default value is: 0

logfile.expirytime (seconds)
Maximum time (seconds) a log file is kept
For more information see expirytime Option.

Unified Config: *.logfile

configutil: logfile.*.expirytime

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: 604800

logfile.filemode
File mode (octal) used when creating log files
For more information see filemode Option.

Introduced in release: 7 Update 4

Updated in release: 8.0

Unified Config: *.logfile

configutil: logfile.*.filemode

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: 0600

logfile.flushinterval (seconds)
Time interval (seconds) between logfile buffer flushes
For more information see flushinterval Option.

Unified Config: *.logfile

configutil: logfile.*.flushinterval

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: 60

auth.has_plain_passwords
LDAP stores plaintext passwords, enables APOP and CRAM-MD5
For more information see has_plain_passwords Option.

Unified Config: auth

configutil: sasl.default.ldap.has_plain_passwords

The default value is: 0

hosteddomains
Control whether the MMP uses Hosted Domains
For more information see hosteddomains Option.

Unified Config: mmp imapproxy popproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

The default value is: 1

ipv6in
Accept inbound IPv6 connections
For more information see ipv6in Option.

Introduced in release: 7 Update 1

Unified Config: base mmp

configutil: local.ipv6.in

Legacy config file(s): AService.cfg

The default value is: 0

ipv6out
Attempt outbound IPv6 connections
For more information see ipv6out Option.

Introduced in release: 7 Update 1

Unified Config: base mmp

configutil: local.ipv6.out

Legacy config file(s): AService.cfg

The default value is: 0

ipv6sortorder
Control the order of using IPv4 (A) vs. IPv6 (AAAA) records
For more information see ipv6sortorder Option.

Introduced in release: 7 Update 1

Unified Config: base mmp

configutil: local.ipv6.sortorder

Legacy config file(s): AService.cfg

The default value is: default

langlist
MMP's language list response to IMAP LANGUAGE
For more information see langlist Option.

Unified Config: mmp imapproxy

Legacy config file(s): ImapProxyAService.cfg

The default value is: i-default EN

ldapcachesize

The MMP can cache results of user searches. The ldapcachesize option (available under mmp, imapproxy, popproxy, and vdomain) defines the number of cache entries; ldapcachettl defines the length of time the entries are preserved in seconds. Lower values will reduce performance, but result in faster recognition of LDAP user entry changes. Higher values will increase performance, but result in delayed recognition of LDAP user entry changes. If this is not set, then the authcachesize option's value will be used instead. If ldapcachesize is set, it will override authcachesize for MMP purposes only.

Unified Config: mmp imapproxy popproxy submitproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg vdmap.cfg

ldapcachettl (seconds)
Timeout value for MMP's cache of LDAP user lookup results
For more information see ldapcachettl Option.

Unified Config: mmp imapproxy popproxy submitproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg vdmap.cfg

The default value is: 900

base.ldapmodifytimeout
Time (seconds) for LDAP modify operations to complete
For more information see ldapmodifytimeout Option.

Unified Config: base

configutil: local.ldapmodifytimeout

The default value is: 60

ldappendingoplimit
In-progress LDAP connections the MMP will allow
For more information see ldappendingoplimit Option.

Updated in release: 7.0.5

Unified Config: mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 128

ldaprefreshinterval (seconds)
Seconds the MMP will keep a connection open to LDAP server
For more information see ldaprefreshinterval Option.

Unified Config: mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 2100

base.ldapsearchtimeout (seconds)
Time (seconds) to wait for an LDAP search to complete
For more information see ldapsearchtimeout Option.

Unified Config: base

configutil: local.ldapsearchtimeout

The default value is: 60

ldaptimeout (seconds)
DEPRECATED: See ldapsearchtimeout and ldapmodifytimeout
For more information see ldaptimeout Option.

Deprecated in release: 7.0.5

Unified Config: mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 60

ldapurl
DEPRECATED: Instead use dcroot and ugldap* options
For more information see ldapurl Option.

Deprecated in release: 7.0.5

Unified Config: mmp imapproxy popproxy submitproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: ldap://localhost/o=internet

logdir
Directory path for log files (nslog)
For more information see logdir Option.

Unified Config: mmp imapproxy popproxy submitproxy *.logfile

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

base.loginseparator
Character(s) for login separator (between userid & domain)
For more information see loginseparator Option.

Unified Config: base

configutil: service.loginseparator

The default value is: @

loglevel
nslog logging level
For more information see loglevel Option.

Updated in release: 7 Update 1

Unified Config: mmp imapproxy popproxy submitproxy *.logfile

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: notice

mailhostattrs
List of LDAP attributes identifying user's mailHost
For more information see mailhostattrs Option.

Unified Config: mmp imapproxy popproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

The default value is: mailHost

maxconcurrentconnectionattempts
Max # of outstanding connection attempts to same backend
For more information see maxconcurrentconnectionattempts Option.

Introduced in release: 7 Update 3

Updated in release: 7.0.5

Unified Config: mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 32

logfile.maxlogfiles
Maximum number of log files to retain
For more information see maxlogfiles Option.

Unified Config: *.logfile

configutil: logfile.*.maxlogfiles

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: 10

logfile.maxlogfilesize (bytes)
Max size (bytes) for nslog files; triggers rollover
For more information see maxlogfilesize Option.

Updated in release: 7.0.5

Unified Config: *.logfile

configutil: logfile.*.maxlogfilesize

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: 20971520

logfile.maxlogsize (bytes)
Max total size (bytes) for nslog files for a service
For more information see maxlogsize Option.

Updated in release: 7.0.5

Unified Config: *.logfile

configutil: logfile.*.maxlogsize

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: 209715200

maxthreads

The maxthreads MMP option specifies the maximum number of threads allowed per server process for the selected server. The MMP does not count worker threads attempting to lookup or connect to a back-end server against this limit; see the separate maxconcurrentconnectionattempts option to limit such connections.

Introduced to MMP in release: 7 Update 3

Unified Config: mmp

Legacy config file(s): AService.cfg

The default value is: 250

memcached_enable
Badguy info will be stored in memached
For more information see memcached_enable Option.

Introduced in release: future

Unified Config: mmp

The default value is: 0

memcached_host
memcached server host name
For more information see memcached_host Option.

Introduced in release: future

Unified Config: mmp

memcached_port
memcached listening port
For more information see memcached_port Option.

Introduced in release: future

Unified Config: mmp

The default value is: 11211

numprocesses
Number of processes for the relevant service
For more information see numprocesses Option.

Introduced to MMP in release: 7 Update 4 patch 25

Unified Config: mmp

configutil: service.mmp.numprocesses

The default value is: 1

plaintextmincipher

If the plaintextmincipher option under imapproxy or popproxy is > 0, then disable use of plaintext passwords over the respective service unless a security layer (SSL or TLS) is activated for the selected service. This forces users to enable SSL or TLS on their client to login which prevents exposure of their passwords on the network.

Unified Config: imapproxy popproxy

The default value for the imapproxy is: 0

The default value for the popproxy is: 0

polldelay (milliseconds)
Workaround for Solaris poll performance problem
For more information see polldelay Option.

Updated in release: 7.0.5

Unified Config: mmp

Legacy config file(s): AService.cfg

The default value is: -1

This is a restricted option. Setting this to a non-default value may result in an unsupported configuration unless you have been specifically directed to do so by Oracle support.

preauth
Enable pre-authentication by the MMP
For more information see preauth Option.

Unified Config: mmp imapproxy popproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

The default value is: 0

preauthtimeout (seconds)
MMP session timeout prior to authentication
For more information see preauthtimeout Option.

Introduced in release: 6.3 patch 7

Unified Config: imapproxy popproxy submitproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: 600

preferpoll
Solaris-only: Poll calls instead of event completion ports
For more information see preferpoll Option.

Introduced in release: 7.0.5

Updated in release: 8.0.1

Unified Config: base mmp

configutil: local.preferpoll

Legacy config file(s): AService.cfg

The default value is: 0

This is a restricted option. Setting this to a non-default value may result in an unsupported configuration unless you have been specifically directed to do so by Oracle support.

replayformat

The replayformat MMP/IMAP Proxy/POP Proxy/vdomain option takes an argument of a printf-style format string that says how to construct the user ID for replay to the Message Store server. Valid escape sequences are:

%s (user@domain where '@' is the canonical domain delimiter)
%o (original user as sent by the client)
%U (userid only, prior to LDAP lookup)
%V (virtual domain only)
%A[attr] (value of user's attribute "attr")

For example, %A[uid]@%V for a user with joe as the value of the UID LDAP attribute and domain=siroe.com would yield:

joe@siroe.com

For the MMP, when using hosteddomains, the mailAccessProxyReplay attribute in the domain node in the LDAP server overrides this option.

Unified Config: mmp imapproxy popproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

The default value is: %U@%V

replaypass

The replaypass option (available under mmp, imapproxy, and popproxy) is a boolean indicating whether to replay the end-user's password to the back-end IMAP or POP server. If this is set to 0, then the password is not replayed and administrative proxy authentication is used, so the storeadminpass option must also be set.

Introduced in release: 7 Update 5 patch 36

Unified Config: mmp imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 1

requireauthenticationserver
Must use third-party authentication server
For more information see requireauthenticationserver Option.

Introduced in release: 7 Update 4 patch 22

Unified Config: imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 1

restrictplainpasswords
Forbid plaintext password use unless SSL/TLS is active
For more information see restrictplainpasswords Option.

Introduced in release: 5.2 patch 2

Unified Config: mmp imapproxy popproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

The default value is: 0

logfile.rollovertime (seconds)
Max time (s) triggering rollover for nslog file
For more information see rollovertime Option.

Unified Config: *.logfile

configutil: logfile.*.rollovertime

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: 86400

auth.searchfilter
Default authentication and identity search filter for users
For more information see searchfilter Option.

Unified Config: auth

configutil: sasl.default.ldap.searchfilter

The default value is: (&(uid=%U)(objectclass=inetmailuser))

auth.searchfordomain
Control whether directory has users located by domain
For more information see searchfordomain Option.

Unified Config: auth

configutil: sasl.default.ldap.searchfordomain

The default value is: 1

searchformat
A string used constructing LDAP query for user's mail host
For more information see searchformat Option.

Unified Config: mmp imapproxy popproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

The default value is: (uid=%s)

serverdownalert
IMAP ALERT text when MMP cannot connect to Message Store
For more information see serverdownalert Option.

Unified Config: imapproxy

Legacy config file(s): ImapProxyAService.cfg

The default value is: Your IMAP server appears to be temporarily out of service.

spoofemptymailbox
Show empty mailbox if user's POP server is unavailable
For more information see spoofemptymailbox Option.

Unified Config: popproxy

Legacy config file(s): PopProxyAService.cfg

The default value is: 0

spoofmessagefile
Placeholder message to show if POP server is unavailable
For more information see spoofmessagefile Option.

Unified Config: popproxy

Legacy config file(s): PopProxyAService.cfg

spooftempfail
Show empty POP mailbox when user has a temp auth error
For more information see spooftempfail Option.

Introduced in release: 7 Update 4 patch 26

Unified Config: popproxy

Legacy config file(s): PopProxyAService.cfg

The default value is: 0

ssladjustciphersuites
Add, remove or set available SSL cipher suites
For more information see ssladjustciphersuites Option.

Unified Config: base mmp imapproxy popproxy submitproxy vdomain

configutil: local.ssladjustciphersuites

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg vdmap.cfg

sslbacksideport
Store POP and IMAP ports for MMP to connect to using SSL
For more information see sslbacksideport Option.

Unified Config: imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 0

sslcachedir
SSL session cache directory
For more information see sslcachedir Option.

Updated in release: 7.0.5.31

Unified Config: base mmp imapproxy popproxy submitproxy

Legacy config file(s): AService.cfg

sslcertprefix
DEPRECATED: use ssldbprefix instead
For more information see sslcertprefix Option.

Deprecated in release: 7.0.5

Unified Config: mmp imapproxy popproxy submitproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

base.ssldbpath
Specify the location of certificates and key files
For more information see ssldbpath Option.

Unified Config: base

configutil: local.ssldbpath

base.ssldbprefix
Specify the prefixes of the certificate and key files
For more information see ssldbprefix Option.

Unified Config: base

configutil: local.ssldbprefix

sslenable
Whether STARTTLS is enabled for a proxy service
For more information see sslenable Option.

Unified Config: mmp imapproxy popproxy submitproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: 0

sslkeyprefix
DEPRECATED: use ssldbprefix instead
For more information see sslkeyprefix Option.

Deprecated in release: 7.0.5

Unified Config: mmp imapproxy popproxy submitproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

sslnicknames
SSL/TLS server certificate nicknames to offer clients
For more information see sslnicknames Option.

Unified Config: base mmp imapproxy popproxy submitproxy vdomain

configutil: encryption.rsa.nssslpersonalityssl

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg vdmap.cfg

The default value is: Server-Cert

storeadmin
User name of store admin for proxy authentication
For more information see storeadmin Option.

Unified Config: mmp imapproxy popproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

storeadminpass
Password for store admin for proxy authentication
For more information see storeadminpass Option.

Unified Config: mmp imapproxy popproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

base.stressfdwait
Stop accepting new connections if file descriptor shortage
For more information see stressfdwait Option.

Introduced in release: 7.0.5

Unified Config: base

configutil: local.stressfdwait

The default value is: 1

base.stressperiod (seconds)
Time (s) the MMP may be "stressed" prior to restart
For more information see stressperiod Option.

Introduced in release: 7.0.5

Unified Config: base

The default value is: 20

syncldap
Synchronous (rather than asynchronous) LDAP lookups
For more information see syncldap Option.

Introduced in release: 7.0.5

Unified Config: imapproxy popproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 1

logfile.syslogfacility
Direct logging to specified syslog service
For more information see syslogfacility Option.

Unified Config: *.logfile

configutil: logfile.*.syslogfacility

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: none

tcpaccess
Wrap-style filter for the MMP's TCP access control
For more information see tcpaccess Option.

Unified Config: mmp imapproxy popproxy submitproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg vdmap.cfg

tcpaccessattr
User LDAP attribute with mailAllowedServiceAccess semantics
For more information see tcpaccessattr Option.

Unified Config: mmp imapproxy popproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg

The default value is: mailAllowedServiceAccess

timeout (seconds)
Timeout (seconds)
For more information see timeout Option.

Unified Config: mmp imapproxy popproxy submitproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

The default value is: 1800

base.ugldapbasedn
Root of the user/group tree
For more information see ugldapbasedn Option.

Unified Config: base

configutil: local.ugldapbasedn

base.ugldapbindcred
Password for the user/group administrator
For more information see ugldapbindcred Option.

Unified Config: base

configutil: local.ugldapbindcred

base.ugldapbinddn
DN of the user/group administrator
For more information see ugldapbinddn Option.

Unified Config: base

configutil: local.ugldapbinddn

base.ugldaphost
List of LDAP server(s) for user/group lookup
For more information see ugldaphost Option.

Unified Config: base

configutil: local.ugldaphost

base.ugldapport
LDAP port for user/group lookup
For more information see ugldapport Option.

Updated in release: 7.0.5

Unified Config: base

configutil: local.ugldapport

The default value is: 389

base.ugldapusessl
Use SSL to connect to user/group LDAP server
For more information see ugldapusessl Option.

Unified Config: base

configutil: local.ugldapusessl

The default value is: 0

use_nslog

DEPRECATED for the MMP and its components as of MS 8.0: The use_nslog option (available at levels including mmp, imapproxy, and popproxy) may be set to 1 to enable use of nslog() for debugging output. This then enables the use of the logfile options, component.logfile.option-name, (or logfile.component.* in legacy configuration) for controlling logfile creation and rollover.

Updated in release: 8.0

Unified Config: mmp imapproxy popproxy submitproxy

Legacy config file(s): AService.cfg ImapProxyAService.cfg PopProxyAService.cfg

The default value is: 1

usergroupdn
DEPRECATED: Consider using ugldapbasedn instead.
For more information see usergroupdn Option.

Introduced in release: 6.0

Deprecated in release: 7.0.5

Unified Config: mmp imapproxy popproxy submitproxy

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg SmtpProxyAService.cfg

virtualdomaindelim
Acceptable virtual domain delimiter characters
For more information see virtualdomaindelim Option.

Unified Config: mmp imapproxy popproxy vdomain

Legacy config file(s): ImapProxyAService.cfg PopProxyAService.cfg vdmap.cfg