domain
Use these commands to configure a protected domain.
For more information on protected domains and when they are required, see the FortiMail Administration Guide.
Syntax
This command contains many sub-commands. Each sub-command, linked below, is documented in subsequent sections.
config domain
edit <domain_name>
config system disclaimer-message ...
config profile authentication ...
config profile user-import ...
config user mail ...
config profile notification ...
config profile antispam-action ...
config profile antispam ...
config profile antivirus-action ...
config profile antivirus ...
config profile content-action ...
config profile content ...
config profile cousin-domain ...
config profile email-address-group ...
config profile impersonation ...
config profile weighted-analysis ...
config profile resource ...
next
end
|
Variable |
Description |
Default |
|
Enter the domain name of the protected domain. For example, if FortiMail will protect email addresses that end in Generally, your protected domain will use a valid, globally-resolvable top-level domain (TLD) such as |
|
Related topics
config cal resource
Use this sub-command to configure a resource for calendar shares in FortiMail webmail in a protected domain.
Syntax
This sub-command is available from within the command domain.
config cal resource
edit <resource_name>
[set description "<comment_str>"]
set management-users <user_email>
end
config customized-message
Use this sub-command to configure domain-specific customized messages, such as disclaimers and personal quarantine report email templates.
|
|
These sub-commands are only available after you:
(When you create a protected domain, its domain-specific customized messages are not automatically initialized and prepopulated. Instead, initialization occurs upon the first time that you choose to use them, using the above procedure.) |
Syntax
This sub-command is available from within the command domain.
config customized-message
edit disclaimer-insertion
config variable
edit <variable_name>
set display-name <gui-label_str>
next
end
config message
edit <disclaimer_name>
[set description "<comment_str>"]
set format {html | multiline | text}
set location {beginning | end}
set disclaimer-convert-text-to-html-status {enable | disable}
set disclaimer-preview-orig-msg-status {enable | disable}
next
end
edit report-quarantine-summary
config variable
edit <variable_name>
set display-name <gui-label_str>
end
config email-template
edit {default | default-with-icons}
[set description "<comment_str>"]
set html-body "<body-html_str>"
set text-body "<body-text_str>"
end
end
|
Variable |
Description |
Default |
|
Enter a variable name that you want to add or edit, such as |
|
|
|
Enter the name of the disclaimer message. |
|
|
|
Enter the value of the variable or custom message. |
No default for new variables. Otherwise the value is from the default message. |
|
|
Enter a comment or description. |
|
|
|
Enter a label that will appear in the variable list when you click Insert Variables in the GUI while customizing a message or creating a variable. For example, you could enter |
No default for new variables. Otherwise the value is from the default message. |
|
|
Enter the sender email address ( This setting is available only for email templates. Note: By default, the setting is empty. Some services such as Microsoft 365 do not accept an empty sender email address ( |
|
|
|
Enter the sender email address ( This setting is available only for email templates. |
%%RELEASE_CONTROL_USER%% |
|
|
Enter the body that will be used in the HTML format version of the email. Can be up to 4000 characters. This setting is available only for email templates. |
HTML for the default message, using default variables. |
|
|
Enter the subject line that will be used in the email. You can either enter text directly, or insert a variable such as This setting is available only for email templates. |
Subject line for the default message, using default variables. |
|
|
Enter the body that will be used in the plain text format version of the email. Can be up to 4000 characters. This setting is available only for email templates. |
Plain text for the default message, using default variables. |
|
|
Select the format of the email. This setting is available only for email templates. |
text |
|
|
Select where in the message body to insert the custom message. This setting is available only if the custom message type is Note: This setting is ignored if the disclaimer is applied by an antispam action profile, antivirus action profile, or content action profile's |
beginning |
|
|
Enable if either:
Plain text email (MIME type Multipart email is not effected. This setting is available only if the custom message type is |
disable |
|
|
Enable if you want the preview to use the original message's content. In email clients such as Microsoft Outlook, Apple Mail on iOS, and FortiMail webmail, message preview text appears in the message list and/or notification banners. Disable if you want the preview to start with the disclaimer. Original contents may still appear after the disclaimer if the disclaimer is short, depending on how much text the email client shows for the preview. This setting is available only if Note: This setting is ignored if both:
(HTML is required to control display of the preview.) This setting is also ignored if the disclaimer is applied by an antispam action profile, antivirus action profile, or content action profile, and that |
disable |
config domain-info
Use this sub-command to configure customer account information for multi-tenancy.
Syntax
This sub-command is available from within the command domain.
config domain-info
[set comment "<comment_str>"]
set customer-name <customer_str>
set customer-email <customer_email>
end
config domain-setting
Use this sub-command to configure many settings for a protected domain.
Syntax
This sub-command is available from within the object domain.
config domain-setting
[set comment "<comment_str>"]
set is-sub-domain {enable | disable}
set main-domain <protected-domain_name>
set relay-type {host | ip-pool | ldap-domain-routing | mx-lookup | mx-lookup-alt-domain}
set host {<smtp-server_fqdn> | <smtp-server_ipv4>}
set use-stmps {enable | disable}
set fallback-use-smtps {enable | disable}
set fallback-host {<smtp-server_fqdn> | <smtp-server_ipv4>}
set relay-ip-group <ip-group_name>
set ldap-domain-routing-profile <ldap-profile_name>
set mx-lookup-alt-domain-name <domain_str>
set domain-association-mxlookup {self | parent}
set relay-auth-status {enable | disable}
set relay-auth-username <username_str>
set relay-auth-password <password_str>
set relay-auth-type {auto | cram-md5 | digest-md5 | login | ntlm | plain}
set recipient-verification {disable | imported-user | ldap | smtp}
set alt-smtp-verification {enable | disable}
set alt-smtp-verification-host {<smtp-server_fqdn> | <smtp-server_ipv4>}
set alt-smtp-verification-port <port_int>
set alt-smtp-verification-smtps {enable | disable}
set smtp-mail-from-addr-status {use-system-setting | use-domain-setting}
set smtp-mail-from-addr <sender_email>
set recipient-verification-profile <profile_name>
set smtp-recipient-verification-command {rcpt | vrfy}
set smtp-recipient-verification-accept-reply-string "<accept_pattern>"
set recipient-verification-invalid-user-action {reject | discard}
set recipient-verification-background {disable | ldap | purge-inactive | smtp}
set recipient-verification-background-profile <ldap-profile_name>
set recipient-retention-period <days_int>
set tp-server-on-port <port_int>
set tp-use-domain-mta {yes | no}
set ldap-user-profile <profile_name>
set user-management-web-service-status {enable | disable}
set ldap-routing-status {enable | disable}
set ldap-routing-profile <ldap-profile_name>
set ldap-asav-status {enable | disable}
set ldap-asav-profile <ldap-profile_name>
set quarantine-report-to-individual {enable | disable}
set quarantine-report-to-alt {enable | disable}
set quarantine-report-to-alt-addr <recipient_email>
set quarantine-report-to-ldap-groupowner {enable | disable}
set ldap-groupowner-profile <ldap-profile_name>
set group-recipient-only {enable | disable}
set group-exclude-individual {enable | disable}
set quarantine-report-schedule-status {enable | disable}
set schedule-days {Sunday Monday Tuesday Wednesday Thursday Friday Saturday}
set quarantine-report-status {enable | disable}
set report-template-name <profile_name>
set arc-sealing-option {all | disable | incoming | outgoing}
set dkim-signing-option {all | disable | incoming | outgoing}
set dmarc-report-analysis-status {enable | disable | use-system-setting}
set dmarc-report-analysis-rua-address-mode {auto-discover | manual}
set dmarc-report-analysis-rua-address <recipient_email>
set dmarc-report-generation-status {enable | disable | monitor-only | use-system-setting}
set dmarc-report-generation-from-addr-localpart <localpart_str>
set domain
set disclaimer-status {disabled | use-domain-setting | use-system-setting}
set sender-addr-rate-ctrl-state {enable | disable}
set sender-addr-rate-ctrl-max-msgs-state {enable | disable}
set sender-addr-rate-ctrl-max-msgs <messages_int>
set sender-addr-rate-ctrl-max-recipients-state {enable | disable}
set sender-addr-rate-ctrl-max-recipients <recipients_int>
set sender-addr-rate-ctrl-max-size-state {enable | disable}
set sender-addr-rate-ctrl-max-size <size_int>
set sender-addr-rate-ctrl-max-spam-state {enable | disable}
set sender-addr-rate-ctrl-max-spam <spam_int>
set sender-addr-rate-notification-state {enable | disable}
set sender-addr-rate-notification-profile <profile_name>
config sender-addr-rate-ctrl-exempt
edit <rule_index>
set pattern-type {wildcard | regexp}
set sender-pattern <sender_pattern>
end
set sender-addr-rate-ctrl-action {none | reject | temp-fail}
set webmail-language <language_name>
set webmail-theme {Blue | Dark | Green | Light-Blue | Neutrino | Red | Use-system-setting}
set sso-status {enable | disable}
set sso-profile <profile_name>
set max-message-size <limit_int>
set addressbook {domain | none | system}
set greeting-with-host-name {domainname | hostname | othername}
set other-helo-greeting <hostname_str>
set ip-pool-direction {outgoing | incoming | both}
set remove-outgoing-received-header {enable | disable}
set global-bayesian {enable | disable}
set bypass-bounce-verification {enable | disable}
set email-continuity-status {enable | disable}
set email-migration-status {enable | disable}
set is-service-domain {enable | disable}
set max-user-number <users_limit>
set mail-access {webmail pop imap}
set webmail-service-type {full limited}
end
|
Variable |
Description |
Default |
||
|
Enter the number to identify the rule. To create a rule with the first available number, enter |
|
|||
|
Select whether to add newly created email users to the system address book, domain address book, or none. This setting is available if operation-mode {gateway | server | transparent} is |
domain |
|||
|
alt-smtp-verification-host {<smtp-server_fqdn> | <smtp-server_ipv4>} |
Enter the fully qualified domain name (FQDN) or IP address of the SMTP server to use for recipient verification. Also configure This setting is not available in server mode. This setting applies if |
|
||
|
Enter the port number on which the SMTP server for recipient verification listens. If you enable This setting is not available in server mode. This setting applies if |
25 |
|||
|
Enable to use SMTPS (secure SMTP) for connections to the SMTP server for recipient verification. This setting is not available in server mode. This setting applies if |
|
|||
|
Enable to perform recipient verification with the SMTP server in This setting in not available in server mode. This setting applies if |
disable |
|||
|
Select either:
This setting applies only if the ARC keys have been imported or generated. |
disable |
|||
|
Enable to omit bounce address tag verification of email incoming to this protected domain. Alternatively, you can enable For information on enabling bounce address tagging and verification (BATV), see antispam bounce-verification. Note: This setting does not omit bounce address tagging of outgoing email. |
disable |
|||
|
Enter a description or comment. |
|
|||
|
disclaimer-status {disabled | use-domain-setting | use-system-setting} |
Select whether to:
This setting applies if disclaimer-per-domain {enable | disable} is |
use-system-setting |
||
|
Enter the disk quota in gigabytes (GB). If the disk quota reaches 90% threshold, a warning email is sent to the domain customer email. If the maximum disk quota of this domain is exceeded, users of this domain will no longer receive any new email. This setting is only available in server mode. |
|
|||
|
Select either:
This setting applies only if the DKIM keys have been imported or generated. |
disable |
|||
|
dmarc-report-analysis-rua-address-mode {auto-discover | manual} |
Select either:
|
auto-discover |
||
|
Enter the recipient email address where FortiMail will send the DMARC report. This setting applies only if dmarc-report-analysis-rua-address-mode {auto-discover | manual} is |
|
|||
|
dmarc-report-analysis-status {enable | disable | use-system-setting} |
Select either:
|
disable |
||
|
Enter the local part of the sender email address when FortiMail sends reports about DMARC checks to that domain name. |
noreply |
|||
|
dmarc-report-generation-status {enable | disable | monitor-only | use-system-setting} |
Select either:
|
use-system-setting |
||
|
If a protected domain's In this setting, select which domain name FortiMail should ask for in associated domains' DNS lookups, either:
This setting is not available in server mode. |
|
|||
|
Enable or disable email continuity. |
disable |
|||
|
Enable email migration from an external server to this protected domain. Email migration is used to move email user accounts and data from an external mail server to this FortiMail system. See the email migration workflow. This setting is available only on server mode, after you have enabled email-migration-status {enable | disable}. |
disable |
|||
|
Enter the fully qualified domain name (FQDN) or IP address of the secondary SMTP server for this protected domain. This SMTP server will be used if the primary SMTP server in This setting is not available in server mode. This setting is used only if |
|
|||
|
Enter the port number on which the secondary SMTP server listens. If you enable This setting is not available in server mode. This setting is used only if |
25 |
|||
|
Enable to use SMTPS for connections originating from or destined for this protected server. This setting is not available in server mode. This setting is used only if |
disable |
|||
|
Enable to use the global Bayesian database instead of the Bayesian database for this protected domain. If you do not need the Bayesian database to be specific to the protected domain, you may want to use the global Bayesian database instead in order to simplify database maintenance and training. Disable to use the per-domain Bayesian database. This setting does not apply if you have enabled use of personal Bayesian databases in an incoming antispam profile, and if the personal Bayesian database is mature. Instead, the FortiMail unit will use the personal Bayesian database. |
disable |
|||
|
Select how the FortiMail unit will identify itself during the
|
hostname |
|||
|
Enable to omit sending the personal quarantine report to the original recipient email address if a group owner exists. This can be used to avoid duplicate reports when the group owner is also a member, or to delegate quarantine responsibilities to a specific person instead of notifying all members. This setting applies if |
disable |
|||
|
Enable to send the personal quarantine report to the group owner if the original recipient email address was for a group. This setting applies if |
enable |
|||
|
Enter the FQDN or IP address of the primary SMTP server for this protected domain. Also configure If NAT (on FortiGate, in a "virtual IP") exists between FortiMail and the server, this is the external IP on the router or firewall instead. If you have a mail relay between FortiMail and the mail server, this could be the relay instead of the mail server. Consider your network topology, directionality of the mail flow, and the operation mode of the FortiMail system. See recipient policy matching and inbound versus outbound email This setting is not available in server mode. This setting is used if |
|
|||
|
Select the direction of SMTP traffic to use an IP pool for. This setting is only available after you configure |
|
|||
|
You can use a pool of IP addresses as the source IP address when sending email from this domain, or as the destination IP address when receiving email destined to this domain, or as both the source and destination IP addresses. If you want to use the IP pool as the source IP address for this protected domain, according to the sender’s email address in the envelope ( If you want to use the IP pool as the destination IP address (virtual host) for this protected domain, according to the recipient’s email address in the envelope ( If you want to use the IP pool as both the destination and source IP address, select the IP pool to use and select Each email that the FortiMail unit sends will use the next IP address in the range. When the last IP address in the range is used, the next email will use the first IP address. |
|
|||
|
Enable to use this domain's SMTP server to deliver email. |
disable |
|||
|
Select to indicate whether or not the protected domain you are creating is a subdomain of an existing protected domain. If it is, then also configure Subdomains, like their parent protected domains, can be selected when configuring policies specific to that subdomain. Unlike top-level protected domains, however, subdomains will be displayed as grouped under the parent protected domain when viewing the list of protected domains. This setting is available only when another protected domain exists to select as the parent domain. |
disable |
|||
|
Select the name of an LDAP profile where you have configured scan preferences (see asav-state {enable | disable}). This setting applies if |
|
|||
Enable to query an LDAP server for an email user’s preferences to enable or disable antispam, antivirus, and/or content processing for email messages destined for them. Also configure ldap-asav-profile <ldap-profile_name>. |
disable |
|||
|
Select the name of the LDAP profile that has the FQDN or IP address of the SMTP server you want to query (see domain-query <query_str>). Also configure This setting is not available in server mode. This setting is available if |
|
|||
|
Select the name of an LDAP profile that will be used to send the personal quarantine report to a group owner (see group-owner {enable | disable}), rather than individual recipients. This setting applies if |
|
|||
|
Select the name of an LDAP profile that will be used to perform mail routing (see routing-state {enable | disable}). This setting applies if |
|
|||
|
Enable or disable mail routing according to query results from an LDAP profile. Also configure |
disable |
|||
|
Select the name of an LDAP profile, if any, that will be used:
|
|
|||
|
Select which mail access protocols are allowed for email users in the protected domain: POP3, IMAP, and/or webmail (HTTP/HTTPS). |
webmail |
|||
|
Select the protected domain that is the parent of this subdomain. For example, This setting is available only when |
|
|||
|
Enable then type the limit in kilobytes (KB) of the message size. Email messages over the threshold size are rejected.
|
204800 |
|||
|
Enter the maximum number of email account in this protected domain. |
|
|||
|
Enter the maximum disk quota, in megabytes (MB), for each email user in the protected domain. This number, multiplied by the number in |
|
|||
|
Enter the domain name to use when querying the DNS server for the protected domain's MX records. This setting is not available in server mode. This setting is available if |
|
|||
|
Enter the name to use for the SMTP greeting ( This setting is available only if |
|
|||
|
Select whether the pattern matching engine will use wild cards ( See also regular expression and wild card examples for FortiMail. |
wildcard |
|||
|
Enter the port number on which the primary SMTP server listens. If NAT (on FortiGate, this is called a "virtual IP") exists between FortiMail and the server, this is the port forward on the router or firewall instead. If you enable This setting is not available in server mode. This setting is used if |
25 |
|||
|
Select which schedule to use when sending personal quarantine reports, either:
|
disable |
|||
|
Select which email template to use when sending personal quarantine reports, either:
|
disable |
|||
|
Enter the alternative email address that will receive the personal quarantine report. |
|
|||
|
Enable to send the personal quarantine report to a recipient email address other than the original recipients or group owner. Also configure For example, you might delegate quarantine reports by sending them to an administrator whose email address is not in the protected domain, such as |
disable |
|||
|
Enable to send the personal quarantine report to all recipient email addresses in the original email. |
enable |
|||
|
Enable to send the personal quarantine report to a group owner, rather than the original recipient email addresses. Also configure |
disable |
|||
|
Enter the retention period in days for inactive user accounts. Valid values are 15-180. This setting is not available in server mode. This setting applies if |
60 |
|||
|
recipient-verification-background-profile <ldap-profile_name> |
Select an LDAP profile with a user query. This setting is not available in server mode. This setting applies if |
|
||
|
recipient-verification-background {disable | ldap | purge-inactive | smtp} |
Every day, FortiMail can remove personal quarantine folders for which an email user account does not currently exist on the protected email server, or for stale accounts that are inactive. The time is configurable in Select how to confirm that a personal quarantine is valid, either:
This setting is not available in server mode. Tip: To improve performance, disable this feature on the day after enabling |
|
||
|
recipient-verification-invalid-user-action {reject | discard} |
Select which SMTP reply code to return to the client if the recipient is not valid. This setting is not available for server mode. This setting applies if you have selected any recipient verification method in |
reject |
||
|
Select an LDAP profile with a user query to use for recipient verification. This setting is not available for server mode. This setting applies if |
|
|||
|
recipient-verification {disable | imported-user | ldap | smtp} |
FortiMail can confirm that the recipient email address in the message envelope ( Select how to confirm that the recipient exists, either:
If you select recipient verification, also configure |
disable |
||
|
Enter the password for authentication with the SMTP server. This setting is not available in server mode. |
|
|||
|
Enable to use SMTP authentication for connections to this protected domain's SMTP server. Also configure This setting is not available in server mode. |
disable |
|||
|
relay-auth-type {auto | cram-md5 | digest-md5 | login | ntlm | plain} |
Select the type of SMTP authentication, either:
This setting is not available in server mode. |
auto |
||
|
Enter the username for authentication with the SMTP server. This setting is not available in server mode. |
|
|||
|
Select the name of an IP group that defines the SMTP servers for the protected domain. Also configure This setting is not available in server mode. This setting is available if |
|
|||
|
relay-type {host | ip-pool | ldap-domain-routing | mx-lookup | mx-lookup-alt-domain} |
Select how to define the SMTP server which will receive email for the protected domain from the FortiMail system, either:
This setting is not available in server mode. |
host |
||
|
Enable to remove all
Alternatively, you can remove this header from any matching email using session profiles. See remove-received-headers {enable | disable}. |
disable |
|||
|
Select which template to use for the personal quarantine reports for this protected domain. This setting is available if |
|
|||
|
schedule-days {Sunday Monday Tuesday Wednesday Thursday Friday Saturday} |
Select the days of the week when the personal quarantine reports for this protected domain will be generated. This setting is available if |
|
||
|
Select the hour of the day when the personal quarantine reports for this protected domain will be generated. Valid range is from 0 to 23. This setting is available if |
|
|||
|
Select which SMTP reply code to send to an SMTP client when a user exceeds any of the sender address rate limits. This setting applies only if |
|
|||
|
Enable to rate limit email from sender email addresses by maximum number of messages. Also configure This setting applies only if |
disable |
|||
|
Enter the maximum number of emails per sender email address in each 30 minute time interval. This setting applies only if |
30 |
|||
|
sender-addr-rate-ctrl-max-recipients-state {enable | disable} |
Enable to rate limit email from sender email addresses by maximum number of unique recipient email addresses. Also configure This setting applies only if |
disable |
||
|
Enter the maximum number of unique email recipient addresses per sender email address in each 30 minute time interval. This setting applies only if |
|
|||
|
Enable to rate limit email from sender email addresses by message size total. Also configure This setting applies only if |
disable |
|||
|
Enter the maximum size, in megabytes (MB), per sender email address in each 30 minute time interval. This setting applies only if |
100 |
|||
|
Enable to rate limit email from sender email addresses by whether or not FortiMail detected spam from them. If the sender's email are often detected as spam, then it is probable that they are intentionally sending unwanted email or their account security has been compromised. Also configure This setting applies only if |
disable |
|||
|
Enter the maximum number of email deemed to be spam by FortiMail that will be accepted per sender email address in each 30 minute time interval. This setting applies only if |
|
|||
|
Enable or disable rate limits based upon the sender email address for this protected domain. Also configure |
disable |
|||
|
Select which notification profile to use for sender address rate control in this protected domain. This setting applies only if |
|
|||
|
If the user directly connects to FortiMail to send email, then This setting applies only if |
disable |
|||
|
Enter a pattern that matches sender email addresses that are exempt from sender address rate limits. Valid syntax varies by |
|
|||
|
smtp-mail-from-addr-status {use-system-setting | use-domain-setting} |
Select which sender email address that the FortiMail will use during recipient verification, either:
This setting is available if |
use-system-setting |
||
|
Enter the sender email address, if any, that FortiMail will use in the SMTP envelope when connecting for recipient verification. This setting in not available in server mode. This setting is available if Note: Some services such as Microsoft 365 do not accept an empty sender email address ( |
|
|||
|
smtp-recipient-verification-accept-reply-string "<accept_pattern>" |
When FortiMail queries the SMTP server for recipient verification:
For example, if the recipient is a group or mailing list such as This setting in not available in server mode. This setting is available if |
|
||
|
Select which SMTP command that the FortiMail system uses to query the SMTP server to verify that the recipient address is an email user account that currently exists, either:
This setting in not available in server mode. This setting is available if |
rcpt |
|||
|
Select the name of an SSO profile. |
|
|||
|
Enable for users in the protected domain to be able to log in via the authentication server defined in a single sign-on (SSO) profile. Also configure For details, see profile sso and system saml. |
disable |
|||
|
Enable to preserve the IP address or domain name of the SMTP client for incoming email messages in the:
This masks the existence of the FortiMail system to the protected SMTP server. Disable to replace the SMTP client’s IP address or domain name with that of the FortiMail system. For example, an external SMTP client might have the IP address 172.168.1.1, and the FortiMailsystem might have the domain name Received: from 192.168.1.1 (EHLO 172.16.1.1) (192.168.1.1) by smtp.external.example.com with SMTP; Fri, 24 Jul 2008 07:12:40 -0800 Received: from smtpa ([172.16.1.2]) by [172.16.1.1] with SMTP id kAOFESEN001901 for <user1@external.example.com>; Fri, 24 Jul 2008 15:14:28 GMT But if the option is disabled, the message headers would contain: Received: from 192.168.1.1 (EHLO fortimail.example.com) (192.168.1.1) by smtp.external.example.com with SMTP; Fri, 24 Jul 2008 07:17:45 -0800 Received: from smtpa ([172.16.1.2]) by fortimail.example.com with SMTP id kAOFJl4j002011 for <user1@external.example.com>; Fri, 24 Jul 2008 15:19:47 GMT This setting is only available in transparent mode. Tip: If the protected SMTP server applies rate limiting according to IP addresses, enabling this setting can improve performance. The rate limit will then be separate for each client connecting to the protected SMTP server, rather than shared among all connections handled by the FortiMail system. Note: Unless you have enabled |
no |
|||
|
Select the network interface (port) to which the protected SMTP server is connected. This setting is only available in transparent mode. Note: Selecting the wrong network interface will result in the FortiMail sending email traffic to the wrong network interface. |
0 |
|||
|
Enable to use the protected SMTP server, instead of the FortiMail built-in MTA, to deliver outgoing email messages from the SMTP clients whose sending MTA is the protected SMTP server. For example, if the protected domain example.com has the SMTP server 192.168.1.1, and an SMTP client for Disable to relay email using the built-in MTA to either the SMTP relay defined in This setting does not affect incoming connections containing incoming email messages, which will always be handled by the built-in MTA. For details, see how to determine when FortiMail uses the proxies instead of the built-in MTA. This setting is only available in transparent mode. Note: This setting will be ignored for email that matches an antispam action profile, antivirus action profile, or content action profile where you have enabled alternate-host-status {enable | disable}. |
no |
|||
|
Enable to use SMTPS (secure SMTP) for connections to this protected domain's SMTP server. This setting is not available in server mode. This setting is used if |
disable |
|||
|
Enable to use FortiMail to manage email user accounts that are stored on FortiAuthenticator. This allows you to use accounts that are already defined in a centralized directory, instead of configuring them locally on FortiMail (see config user mail). This can be useful for larger deployments with many email addresses that would otherwise exceed the maximum number of users on FortiMail. Some account information that is FortiMail-specific, such as user preferences, may still be required to be configured locally. This setting is available only in server mode. This setting is used if a FortiAuthenticator is selected in |
disable |
|||
|
Select the language that the FortiMail unit will to display webmail and quarantine folder in the GUI for users. By default, the FortiMail unit uses the same language as the GUI for administrators. |
|
|||
|
Select either:
|
|
|||
|
webmail-theme {Blue | Dark | Green | Light-Blue | Neutrino | Red | Use-system-setting} |
Select a default color theme for the webmail and quarantine GUI after users log in. Alternatively, you can set this default for all protected domains. See webmail-theme {Blue | Dark | Green | Light-Blue | Neutrino | Red}. If webmail-theme-status {enable | disable} is |
Use-system-setting |
config file filter
Use this sub-command to configure file filter options, including filtering by file extension type and Multipurpose Internet Mail Extension (MIME) type. File filters define the email attachment file types and file extensions to be scanned and are used in attachment scan rules.
Syntax
This sub-command is available from within the command domain.
config file filter
edit <file-type_str>
[set description "<comment_str>"]
set extension <file-extension_pattern>
end
|
Variable |
Description |
Default |
|
Enter a unique name for the file attachment type. |
|
|
|
Enter a description or comment. |
|
|
|
Enter a file extension expressed as a wildcard pattern, for example:
|
|
|
|
Enter a MIME type in the format For example, to filter by image, and specifically for PNG, enter: set mime-type image/png To filter for all video formats, enter: set mime-type video/* |
|
Related topics
config policy recipient
Use this sub-command to configure a recipient-based policy for a protected domain. To configure system-wide policies, see policy recipient instead.
Syntax
This sub-command is available from within the command domain.
config policy recipient
edit <policy_index>
[set comment "<comment_str>"]
set direction {incoming | outgoing}
set sender-name <local-part_str>
set sender-domain <domain_name>
set sender-regex "<sender_pattern>"
set sender-email-address-group <group_name>
set profile-ldap-sender <ldap-profile_name>
set sender-import-attribute-name <name_str>
set sender-import-attribute-value <value_str>
set sender-option {envelope-from | envelope-or-header-from | header-from}
set sender-exclusion-status {enable | disable}
set sender-exclusion-type {email-address-group | user-regex | user-wildcard}
set sender-exclusion-name "<local-part-str>"
set sender-exclusion-domain "<domain-part_str>"
set sender-exclusion-regex "<exclusion_pattern>"
set sender-exclusion-email-address-group <group_name>
set recipient-name "<local-part_str>"
set recipient-domain "<domain_str>"
set recipient-regex "<recipient_pattern>"
set recipient-email-address-group <group_name>
set profile-ldap-recipient <ldap-profile_name>
set recipient-import-attribute-name <name_str>
set recipient-import-attribute-value <value_str>
set recipient-exclusion-status {enable | disable}
set recipient-exclusion-type {email-address-group | user-regex | user-wildcard}
set recipient-exclusion-name "<local-part-str>"
set recipient-exclusion-domain "<domain-part_str>"
set recipient-exclusion-regex "<exclusion_pattern>"
set recipient-exclusion-email-address-group <group_name>
set profile-antispam <antispam_name>
set profile-antivirus <antivirus_name>
set profile-content <profile_name>
set profile-dlp <profile_name>
set profile-resource <profile_name>
set profile-auth-type {imap | ldap | local | none | pop3 | radius | smtp}
set profile-auth-imap <imap_name>
set profile-auth-ldap <ldap_name>
set profile-auth-pop3 <pop3_name>
set profile-auth-radius <radius_name>
set profile-auth-smtp <smtp_name>
set auth-allow-smtp {enable | disable}
set pkiauth {enable | disable}
set certificate-required {yes | no}
set smtp-diff-identity {enable | disable}
set smtp-diff-identity-ldap {enable | disable}
set smtp-diff-identity-ldap-profile <profile_name>
next
end
|
Variable |
Description |
Default |
|
Enter the index number of the recipient-based policy. To view a list of existing entries, enter a question mark ( Note: The ID is automatically assigned when the policy is created, and may be different from its order in the list. See the order of execution for policies. |
|
|
|
Enable to allow the SMTP client to use the SMTP Disable to make SMTP authentication unavailable. This setting is available in gateway Note: This setting allows, but does not require, SMTP authentication. To enforce SMTP authentication, set |
|
|
|
Select either:
This setting is available only if |
no |
|
|
Enter a description or comment. |
|
|
|
Select the direction of email that this policy matches, with respect to protected domains. |
incoming |
|
|
Enable if you want to allow webmail and personal quarantine users to log in by presenting a certificate rather than a user name and password. Also configure This setting is available only if |
disable |
|
|
Enter the name of a PKI user, such as This setting only applies if |
|
|
|
Select which antispam profile, if any, to apply to email matching the policy. Tip: You can use an LDAP query to enable or disable antispam scanning on a per-user basis ( |
|
|
|
Select which antivirus profile, if any, to apply to email matching the policy. |
|
|
|
Select an authentication profile. This setting is available only if |
|
|
|
Select an authentication profile. This setting is available only if |
|
|
|
Select an authentication profile. This setting is available only if |
|
|
|
Select an authentication profile. This setting is available only if |
|
|
|
Select an authentication profile. This setting is available only if |
|
|
|
profile-auth-type {imap | ldap | local | none | pop3 | radius | smtp} |
Select the type of the authentication profile that FortiMail will use to authenticate email users:
Depending on the type that you select, also configure |
none |
|
Select which content profile, if any, to apply to the policy. |
|
|
|
Select which DLP profile, if any, to apply to email matching the policy. |
|
|
|
If |
|
|
|
If |
|
|
|
Select which content profile, if any, to apply to email matching the policy. This setting is available only if FortiMail is operating in server mode or gateway mode. |
|
|
|
Select an import profile. Also configure This setting is available only if:
|
|
|
|
Select an import profile. Also configure This setting is available only if:
|
|
|
|
Enter the local part (username) of recipient email addresses that match this policy. This setting is available only if |
|
|
|
Enter the group of recipient email addresses. This setting is available only if |
|
|
|
Enter the domain name of recipient email addresses that you want to exclude. This setting is available only if |
* |
|
|
Enter the group membership attribute value as it appears in the LDAP directory. This setting is available only if |
|
|
|
Enter the local part (username) of recipient email addresses that you want to exclude. This setting is available only if |
* |
|
|
Enter a regular expression that matches only recipient email addresses that you want to exclude, such as: .*@example\.com This setting is available only if |
|
|
|
Enable if you want to exclude some recipient email addresses from matching this policy. Also configure |
disable |
|
|
recipient-exclusion-type {email-address-group | user-regex | user-wildcard} |
Select how you want to define excluded recipient email addresses. Depending on which you select, also configure This setting is available only if |
user-wildcard |
|
Enter the name of attributes to match users from an import profile. This setting is available only if
|
|
|
|
Enter the value of attributes to match users from an import profile. This setting is available only if
|
|
|
|
Enter the local part (username) of recipient email addresses that match this policy. This setting is available only if |
|
|
|
Enter a regular expression that matches only the recipient email addresses that should match this policy. This setting is available if |
.* |
|
|
recipient-type {email-user-group | import-group | import-user | ldap-group | user-regex | user-wildcard} |
Select how to define recipient ( Depending on which you select, also configure |
user |
|
Enter the domain name of sender email addresses that match this policy. This setting is available only if |
|
|
|
Enter the group membership attribute value as it appears in the LDAP directory. This setting is available only if This setting is available only if |
|
|
|
Enter the domain name of sender email addresses that you want to exclude. This setting is available only if |
* |
|
|
Select a group of email addresses you want to exclude. This setting is available only if |
|
|
|
Enter the local part (username) of sender email addresses that you want to exclude. This setting is available only if |
* |
|
|
Enter a regular expression that matches only sender email addresses that you want to exclude, such as: .*@example\.com This setting is available only if |
|
|
|
Enable if you want to exclude some sender email addresses from matching this policy. Also configure Sender exclusion settings apply only if |
disable |
|
|
sender-exclusion-type {email-address-group | user-regex | user-wildcard} |
Select how you want to define excluded sender email addresses. Depending on which you select, also configure This setting is available only if |
user-wildcard |
|
Enter the name of attributes to match users from an import profile. This setting is available only if
|
|
|
|
Enter the value of attributes to match users from an import profile. This setting is available only if
|
|
|
|
Enter the local part (username) of sender email addresses that match this policy. This setting is available only if sender-type {email-user-group | import-group | import-user | ldap-group | user-regex | user-wildcard} is |
|
|
|
sender-option {envelope-from | envelope-or-header-from | header-from} |
Select whether to match this policy based upon the sender email address that is in the SMTP envelope ( This setting is available only if enabled in recipient-policy-sender-option {envelope-from-only | envelope-or-header-from}. Caution: Message headers may be rewritten or fake. Do not match policies based upon the email address in |
envelope-from |
|
Enter a regular expression that matches only the sender email addresses that should match this policy. This setting is only available when |
.* |
|
|
sender-type {email-user-group | import-group | import-user | ldap-group | user-regex | user-wildcard} |
Select how to define sender ( Depending on which you select, also configure profile-ldap-sender <ldap-profile_name>, sender-regex "<sender_pattern>", etc. |
user-wildcard |
|
Disable to allow the SMTP client to send email using a different sender email address ( Enable to require that the sender email address in the SMTP envelope matches the authenticated user name, and reply with an SMTP rejection code if they don't match. This setting is applicable only if profile-auth-type {imap | ldap | local | none | pop3 | radius | smtp}is not |
disable |
|
|
Enable to use a directory query to find and verify the sender's other email addresses. Also configure smtp-diff-identity-ldap-profile <profile_name>. This setting is applicable only if smtp-diff-identity {enable | disable} is Note: If verification succeeds, the sender email sender address in the SMTP envelope ( |
disable |
|
|
Select which LDAP profile to use for verifying an email user's other identities. This setting is applicable only if smtp-diff-identity-ldap {enable | disable} is |
|
|
|
Enable to apply the policy. |
enable |
config profile user-import
Use this command to configure account synchronization to import users from LDAP or Microsoft 365, Entra ID, or Exchange servers.
Syntax
This sub-command is available from within the command domain.
config profile user-import
edit <profile_name>
set bind-password <password_str>
set description "<comment_str>"
set group-display-name <ldap-attribute_str>
set group-primary-address <ldap-attribute_str>
set group-query <query-filter_str>
set group-secondary-address <ldap-attribute_str>
set ldap-secure {enable | disable}
set ldap-server {<ldap-server_ipv4> | ldap-server_fqdn>}
set ldap-version {ver2 | ver3}
set ms365-application-id <application_str>
set ms365-application-secret <password_str>
set ms365-tenant-id <tenant_str>
set recurrence {daily | monthly | none | weekly}
set referrals-chase {enable | disable}
set schedule-days {Monday Tuesday Wednesday Thursday Friday Saturday Sunday}
set user-display-name <ldap-attribute_str>
set user-primary-address <ldap-attribute_str>
set user-query <query-filter_str>
set user-secondary-address <ldap-attribute_str>
next
end
|
Variable |
Description |
Default |
|
Enter the distinguished name (DN) of the part of the LDAP directory tree within which the FortiMail unit will search for user objects, such as User objects should be child nodes of this location. |
|
|
|
Enter the bind DN, such as |
|
|
|
Enter the password of |
|
|
|
Enter a description. |
|
|
|
Enter the LDAP group or mailing list display name attribute. |
|
|
|
Enter the LDAP group or mailing list primary email address attribute. |
|
|
|
Enter the LDAP group or mailing list query string. |
|
|
|
Enter the LDAP group or mailing list secondary email address attribute. |
|
|
|
Enter the port number of the LDAP server. The standard port number for LDAP is 389. The standard port number for SSL-secured LDAP is 636. |
389 |
|
|
Enable or disable (by default) a secure encrypted connection to the LDAP server. |
disable |
|
|
Enter the fully qualified domain name (FQDN) or IP address of the directory server. |
|
|
|
Enter the LDAP server protocol version. |
ver3 |
|
|
Enter the Microsoft 365 application ID. |
|
|
|
Enter the Microsoft 365 application secret. |
|
|
|
Enter the Microsoft 365 tenant ID. |
|
|
|
Define the recurrence/schedule of the remote server synchronization. |
none |
|
| Enable or disable (by default) chasing of referrals. |
disable |
|
|
schedule-days {Monday Tuesday Wednesday Thursday Friday Saturday Sunday} |
Enter the days on which synchronization will occur. |
|
|
Enter the hour of the day at which synchronization will occur, from 0 to 23. |
1 |
|
|
Define the search scope of the LDAP server; either base, one level, or subtree (by default). |
sub |
|
|
Enter the query timeout limit in seconds. Valid range is from 60 to 600. |
60 |
|
|
Enter the remote server profile type. |
ldap |
|
|
Enter the LDAP user's display name attribute. |
|
|
|
Enter the LDAP user's primary email address attribute. |
|
|
|
Enter the LDAP query string to get all users. |
|
|
| Enter the LDAP user's secondary email address attribute. |
Related topics
config system disclaimer-message
Use this command to configure which email will have domain-specific disclaimer messages.
A disclaimer message is text that is added to email to warn the recipient that the email contents may be confidential, or other information required by law, such as unsubscribe links or office addresses. However you could use this feature to insert other text and images, too.
If required, you can exclude some email so that they do not receive a disclaimer. See system disclaimer-exclude.
|
|
Disclaimer insertion may invalidate existing DKIM signatures, requiring an alternative ARC signature. See arc-sealing-option {all | disable | incoming | outgoing}. |
|
|
If |
Syntax
config system disclaimer-message
edit <profile_index>
set sender-domain-type {all | external | internal}
set recipient-domain-type {all | external | internal}
set relationship-strength-status {enable | disable}
set relationship-strength {neutral | strong | weak}
set domain-customized-message {enable | disable}
set customized-message <customized-message_name>
end
|
Variable |
Description |
Default |
|
Enter a number for the entry. |
|
|
|
Select which domain-specific customized message to apply as the disclaimer. To customize the message, configure config customized-message (domain-specific) or customized-message (system-wide). |
default |
|
|
Enable to use a domain-specific disclaimer message. Also configure customized-message <customized-message_name>. Disable to use the system-wide disclaimer message. |
disable |
|
|
Select which type of recipient domains will have the disclaimer message applied to their email. |
internal |
|
|
Select which sender-recipient relationship (SRR) score levels should trigger this disclaimer:
FortiGuard Social Database contains the social mapping of the email communication flow. For example, if |
weak neutral strong |
|
|
(SRR) score levels to trigger this disclaimer. Also configure |
disable |
|
| sender-domain-type {all | external | internal} |
Select which type of sender domains will have the disclaimer message applied to their email. |
external |
|
Enable or disable the entry. |
disable |
Related topics
config user mail
Use this sub-command to configure email user accounts.
Syntax
This sub-command is available from within the command domain.
config user mail
rename <old-user_name> to <new-user_name>
edit <user_name>
set type {local | ldap | radius}
set ldap-profile <profile_name>
set radius-profile <profile_name>
next
end
|
Variable |
Description |
Default |
||
|
The existing user account that you want to rename. |
|
|||
|
Enable or disable the email user account. |
enable |
|||
|
Enter the new name for the user account.
|
|
|||
|
Enter the user name of the email user, such as For example, an email user may have numerous aliases, mail routing, and other email addresses on other systems in your network, such as |
|
|||
|
Select whether to authenticate the user via a remote authentication server, or user accounts defined locally on FortiMail. Depending on your selection, also configure <user_name> and password "<password_str>", or ldap-profile <profile_name>, or radius-profile <profile_name>. |
|
|||
|
Enter the name of the user as it should appear in the For example, an email user whose email address is |
|
|||
|
Enter the password of the local email user. This setting is used only if type {local | ldap | radius} is |
|
|||
|
Select the name of an LDAP profile in which user authentication queries are enabled. This setting is available only if type {local | ldap | radius} is |
|
|||
|
Select the name of a RADIUS profile in which user queries are enabled. This setting is available only if type {local | ldap | radius} is |
|
Related topics
antispam dmarc-report-generation