Date: | 02/08/2013 |
---|---|
Subtitle: | automx configuration parameters |
Manual Section: | 5 |
Manual Group: | automx |
Copyright: | This document has been placed in the public domain. |
The automx automx.conf configuration file specifies all parameters that control the automx configuration system. Parameters not specified in automx.conf are left at their default values.
The general format of the automx.conf file is as follows:
The configuration file is split into sections.
Each section may specify one more services that should be provided to the client. A service must be defined in a section in order to be enabled. Options specific to a service are given using a concatenation of a service name and the parameter it should configure.
The following concatenation of service name smtp and service option _server creates the smtp_server parameter:
smtp_server = mail.example.com
Service names available in automx are shown in the following list. The service options to create parameters are specified in the section called Parameters:
Specifies a path to a file that contains static autoconfiguration options following to the Mozilla schema.
Note
This parameter is valid only if backend = file has been specified.
Specifies a path to a file that contains static autoconfiguration options following to the Microsoft schema.
Note
This parameter is valid only if backend = file has been specified.
Specifies the account type that should be configured:
Setting this option will create an email configuration.
Note
The Microsoft schema specifies additional account_types. Currently automx only supports email.
Specifies whether the response to the client contains configuration settings or if it should visit a different server or use a different address.
Note
This option applies to Microsoft schema only.
automx should use logic provided within this section to identify a different section which holds configuration settings:
backend = file
automx should use logic provided within this section to identify a different section which holds configuration settings:
backend = filter
automx should use general settings defined in the global section:
backend = global
automx should use a mixture of general and individual settings. General settings are set like static settings. Individual settings should be retrieved from an LDAP query:
backend = ldap
See also automx_ldap(5) for a list of LDAP related configuration options.
automx should use a mixture of general and individual settings. General settings are set like static settings. Individual settings should be retrieved from an SQL query:
backend = sql
See also automx_sql(5) for a list of SQL related configuration options.
automx should use general settings provided within the current section:
backend = static
Specifies an “optional display name that indicates the name of the sender (...) that could be displayed to the user of a mail application” (see: 3.4. Address Specification in RFC 5322). The client can decide to accept or change the name.
Note
This option applies to Microsoft schema only.
Specifies a list of domains automx will output autoconfiguration information for.
Specifies a path to a file that contains static mobileconfiguration options following to the Mozilla schema.
Note
This parameter is valid only if backend = file has been specified.
The FQDN domain name of the domain that provides the configuration service:
provider = example.com
Specifies a list of one or more filters whose result outputs a section name. The filters will be used in order specified. The first match ends execution of subsequent filters.
These filters will be used instead of the hard coded, internal domainpart filter, which strictly uses the domainpart taken from the email address the client submitted in its configuration request:
section_filters = server_1, server_2 server_1 = /usr/sbin/postmap -q "%u" hash:/etc/postfix/virtual_alias_domains | \ sed -e 's/^.*@\(\.*\)/\1/g' | grep internal.example.com server_2 = /usr/sbin/postmap -q "%u" hash:/etc/postfix/virtual_alias_domains | \ sed -e 's/^.*@\(\.*\)/\1/g' | grep dmz.example.com
Specifies the method the client should use when it identifies the user in order to gain access to the service. The following options are available:
Note
Thunderbird 3.0 accepts only plain and secure. It will ignore the whole XML file, if other values are given.
Specifies whether the client should use a plaintext or an encrypted transport layer for client-server communication. The following options are available:
The client should try to start with starttls, proceed with ssl and settle with none, if only that is available.
Note
This feature is not available in clients following the Mozilla schema. For these clients automx will always output none as encryption level.
The client should use an SSL3 or TLS1 encrypted transport layer from the start.
Note
This option is typical for smtps, pop3s and imaps services and usually requires a dedicated port on the server for SSL encryption only.
The client should begin communication on an unencrypted port and then upgrade the communication to TLS via the STARTTLS command.
Note
This option is typical for smtp, pop3 and imap services.
Specifies the envelope sender address used when the client sends a message. See the section called Macros and Variables for available options.
Note
This parameter is experimental. The feature is available for Microsoft clients only. For a definition of “author” see also RFC 5598, Section 2.1 User Actors.
Specifies if this service should be used globally for all outgoing messages from all accounts.
Note
This feature is available to clients following the Mozilla schema only.
The following macros and variables can be used within automx to build service configuration.