Fortinet white logo
Fortinet white logo

CLI Reference

config emailfilter profile

config emailfilter profile

Configure Email Filter profiles.

config emailfilter profile
    Description: Configure Email Filter profiles.
    edit <name>
        set comment {var-string}
        set external [enable|disable]
        set fabric-force-sync [enable|disable]
        set fabric-object [enable|disable]
        set fabric-object-source [member|local|...]
        set feature-set [flow|proxy]
        config gmail
            Description: Gmail.
            set log-all [disable|enable]
        end
        config imap
            Description: IMAP.
            set action [pass|tag]
            set log-all [disable|enable]
            set tag-msg {string}
            set tag-type {option1}, {option2}, ...
        end
        config mapi
            Description: MAPI.
            set action [pass|discard]
            set log-all [disable|enable]
        end
        config msn-hotmail
            Description: MSN Hotmail.
            set log-all [disable|enable]
        end
        set options {option1}, {option2}, ...
        config other-webmails
            Description: Other supported webmails.
            set log-all [disable|enable]
        end
        config pop3
            Description: POP3.
            set action [pass|tag]
            set log-all [disable|enable]
            set tag-msg {string}
            set tag-type {option1}, {option2}, ...
        end
        set replacemsg-group {string}
        config smtp
            Description: SMTP.
            set action [pass|tag|...]
            set hdrip [disable|enable]
            set local-override [disable|enable]
            set log-all [disable|enable]
            set tag-msg {string}
            set tag-type {option1}, {option2}, ...
        end
        set spam-bal-table {integer}
        set spam-bword-table {integer}
        set spam-bword-threshold {integer}
        set spam-filtering [enable|disable]
        set spam-iptrust-table {integer}
        set spam-log [disable|enable]
        set spam-log-fortiguard-response [disable|enable]
        set spam-mheader-table {integer}
        set spam-rbl-table {integer}
        set uuid {uuid}
        config yahoo-mail
            Description: Yahoo! Mail.
            set log-all [disable|enable]
        end
    next
end

config emailfilter profile

Parameter

Description

Type

Size

Default

comment

Comment.

var-string

Maximum length: 255

external

Enable/disable external Email inspection.

option

-

disable

Option

Description

enable

Enable setting.

disable

Disable setting.

fabric-force-sync *

Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped.

option

-

disable

Option

Description

enable

Enable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

disable

Disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

fabric-object *

Security Fabric global object setting.

option

-

disable

Option

Description

enable

Object is set as a security fabric-wide global object.

disable

Object is local to this security fabric member.

fabric-object-source *

Source of truth for fabric object.

option

-

root

Option

Description

member

Source of truth for this object is a non-root member of fabric.

local

Source of truth for this object is this security fabric member.

root

Source of truth for this object is the root of the fabric.

feature-set

Flow/proxy feature set.

option

-

flow

Option

Description

flow

Flow feature set.

proxy

Proxy feature set.

name

Profile name.

string

Maximum length: 47

options

Options.

option

-

Option

Description

bannedword

Content block.

spambal

Block/allow list.

spamfsip

Email IP address FortiGuard AntiSpam block list check.

spamfssubmit

Add FortiGuard AntiSpam spam submission text.

spamfschksum

Email checksum FortiGuard AntiSpam check.

spamfsurl

Email content URL FortiGuard AntiSpam check.

spamhelodns

Email helo/ehlo domain DNS check.

spamraddrdns

Email return address DNS check.

spamrbl

Email DNSBL & ORBL check.

spamhdrcheck

Email mime header check.

spamfsphish

Email content phishing URL FortiGuard AntiSpam check.

replacemsg-group

Replacement message group.

string

Maximum length: 35

spam-bal-table

Anti-spam block/allow list table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

spam-bword-table

Anti-spam banned word table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

spam-bword-threshold

Spam banned word threshold.

integer

Minimum value: 0 Maximum value: 2147483647

10

spam-filtering

Enable/disable spam filtering.

option

-

disable

Option

Description

enable

Enable setting.

disable

Disable setting.

spam-iptrust-table

Anti-spam IP trust table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

spam-log

Enable/disable spam logging for email filtering.

option

-

enable

Option

Description

disable

Disable spam logging for email filtering.

enable

Enable spam logging for email filtering.

spam-log-fortiguard-response

Enable/disable logging FortiGuard spam response.

option

-

disable

Option

Description

disable

Disable logging FortiGuard spam response.

enable

Enable logging FortiGuard spam response.

spam-mheader-table

Anti-spam MIME header table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

spam-rbl-table

Anti-spam DNSBL table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

uuid *

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

uuid

Not Specified

00000000-0000-0000-0000-000000000000

* This parameter may not exist in some models.

config gmail

Parameter

Description

Type

Size

Default

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

config imap

Parameter

Description

Type

Size

Default

action

Action for spam email.

option

-

tag

Option

Description

pass

Allow spam email to pass through.

tag

Tag spam email with configured text in subject or header.

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

tag-msg

Subject text or header added to spam email.

string

Maximum length: 63

Spam

tag-type

Tag subject or header for spam email.

option

-

subject spaminfo

Option

Description

subject

Prepend text to spam email subject.

header

Append a user defined mime header to spam email.

spaminfo

Append spam info to spam email header.

config mapi

Parameter

Description

Type

Size

Default

action

Action for spam email.

option

-

pass

Option

Description

pass

Allow spam email to pass through.

discard

Discard (block) spam email.

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

config msn-hotmail

Parameter

Description

Type

Size

Default

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

config other-webmails

Parameter

Description

Type

Size

Default

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

config pop3

Parameter

Description

Type

Size

Default

action

Action for spam email.

option

-

tag

Option

Description

pass

Allow spam email to pass through.

tag

Tag spam email with configured text in subject or header.

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

tag-msg

Subject text or header added to spam email.

string

Maximum length: 63

Spam

tag-type

Tag subject or header for spam email.

option

-

subject spaminfo

Option

Description

subject

Prepend text to spam email subject.

header

Append a user defined mime header to spam email.

spaminfo

Append spam info to spam email header.

config smtp

Parameter

Description

Type

Size

Default

action

Action for spam email.

option

-

discard

Option

Description

pass

Allow spam email to pass through.

tag

Tag spam email with configured text in subject or header.

discard

Discard (block) spam email.

hdrip

Enable/disable SMTP email header IP checks for spamfsip, spamrbl, and spambal filters.

option

-

disable

Option

Description

disable

Disable SMTP email header IP checks for spamfsip, spamrbl, and spambal filters.

enable

Enable SMTP email header IP checks for spamfsip, spamrbl, and spambal filters.

local-override

Enable/disable local filter to override SMTP remote check result.

option

-

disable

Option

Description

disable

Disable local filter to override SMTP remote check result.

enable

Enable local filter to override SMTP remote check result.

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

tag-msg

Subject text or header added to spam email.

string

Maximum length: 63

Spam

tag-type

Tag subject or header for spam email.

option

-

subject spaminfo

Option

Description

subject

Prepend text to spam email subject.

header

Append a user defined mime header to spam email.

spaminfo

Append spam info to spam email header.

config yahoo-mail

Parameter

Description

Type

Size

Default

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

config emailfilter profile

config emailfilter profile

Configure Email Filter profiles.

config emailfilter profile
    Description: Configure Email Filter profiles.
    edit <name>
        set comment {var-string}
        set external [enable|disable]
        set fabric-force-sync [enable|disable]
        set fabric-object [enable|disable]
        set fabric-object-source [member|local|...]
        set feature-set [flow|proxy]
        config gmail
            Description: Gmail.
            set log-all [disable|enable]
        end
        config imap
            Description: IMAP.
            set action [pass|tag]
            set log-all [disable|enable]
            set tag-msg {string}
            set tag-type {option1}, {option2}, ...
        end
        config mapi
            Description: MAPI.
            set action [pass|discard]
            set log-all [disable|enable]
        end
        config msn-hotmail
            Description: MSN Hotmail.
            set log-all [disable|enable]
        end
        set options {option1}, {option2}, ...
        config other-webmails
            Description: Other supported webmails.
            set log-all [disable|enable]
        end
        config pop3
            Description: POP3.
            set action [pass|tag]
            set log-all [disable|enable]
            set tag-msg {string}
            set tag-type {option1}, {option2}, ...
        end
        set replacemsg-group {string}
        config smtp
            Description: SMTP.
            set action [pass|tag|...]
            set hdrip [disable|enable]
            set local-override [disable|enable]
            set log-all [disable|enable]
            set tag-msg {string}
            set tag-type {option1}, {option2}, ...
        end
        set spam-bal-table {integer}
        set spam-bword-table {integer}
        set spam-bword-threshold {integer}
        set spam-filtering [enable|disable]
        set spam-iptrust-table {integer}
        set spam-log [disable|enable]
        set spam-log-fortiguard-response [disable|enable]
        set spam-mheader-table {integer}
        set spam-rbl-table {integer}
        set uuid {uuid}
        config yahoo-mail
            Description: Yahoo! Mail.
            set log-all [disable|enable]
        end
    next
end

config emailfilter profile

Parameter

Description

Type

Size

Default

comment

Comment.

var-string

Maximum length: 255

external

Enable/disable external Email inspection.

option

-

disable

Option

Description

enable

Enable setting.

disable

Disable setting.

fabric-force-sync *

Enable/disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices. Configuration conflict check is skipped.

option

-

disable

Option

Description

enable

Enable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

disable

Disable forced synchronization of configuration objects from the root FortiGate unit to the downstream devices.

fabric-object *

Security Fabric global object setting.

option

-

disable

Option

Description

enable

Object is set as a security fabric-wide global object.

disable

Object is local to this security fabric member.

fabric-object-source *

Source of truth for fabric object.

option

-

root

Option

Description

member

Source of truth for this object is a non-root member of fabric.

local

Source of truth for this object is this security fabric member.

root

Source of truth for this object is the root of the fabric.

feature-set

Flow/proxy feature set.

option

-

flow

Option

Description

flow

Flow feature set.

proxy

Proxy feature set.

name

Profile name.

string

Maximum length: 47

options

Options.

option

-

Option

Description

bannedword

Content block.

spambal

Block/allow list.

spamfsip

Email IP address FortiGuard AntiSpam block list check.

spamfssubmit

Add FortiGuard AntiSpam spam submission text.

spamfschksum

Email checksum FortiGuard AntiSpam check.

spamfsurl

Email content URL FortiGuard AntiSpam check.

spamhelodns

Email helo/ehlo domain DNS check.

spamraddrdns

Email return address DNS check.

spamrbl

Email DNSBL & ORBL check.

spamhdrcheck

Email mime header check.

spamfsphish

Email content phishing URL FortiGuard AntiSpam check.

replacemsg-group

Replacement message group.

string

Maximum length: 35

spam-bal-table

Anti-spam block/allow list table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

spam-bword-table

Anti-spam banned word table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

spam-bword-threshold

Spam banned word threshold.

integer

Minimum value: 0 Maximum value: 2147483647

10

spam-filtering

Enable/disable spam filtering.

option

-

disable

Option

Description

enable

Enable setting.

disable

Disable setting.

spam-iptrust-table

Anti-spam IP trust table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

spam-log

Enable/disable spam logging for email filtering.

option

-

enable

Option

Description

disable

Disable spam logging for email filtering.

enable

Enable spam logging for email filtering.

spam-log-fortiguard-response

Enable/disable logging FortiGuard spam response.

option

-

disable

Option

Description

disable

Disable logging FortiGuard spam response.

enable

Enable logging FortiGuard spam response.

spam-mheader-table

Anti-spam MIME header table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

spam-rbl-table

Anti-spam DNSBL table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

uuid *

Universally Unique Identifier (UUID; automatically assigned but can be manually reset).

uuid

Not Specified

00000000-0000-0000-0000-000000000000

* This parameter may not exist in some models.

config gmail

Parameter

Description

Type

Size

Default

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

config imap

Parameter

Description

Type

Size

Default

action

Action for spam email.

option

-

tag

Option

Description

pass

Allow spam email to pass through.

tag

Tag spam email with configured text in subject or header.

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

tag-msg

Subject text or header added to spam email.

string

Maximum length: 63

Spam

tag-type

Tag subject or header for spam email.

option

-

subject spaminfo

Option

Description

subject

Prepend text to spam email subject.

header

Append a user defined mime header to spam email.

spaminfo

Append spam info to spam email header.

config mapi

Parameter

Description

Type

Size

Default

action

Action for spam email.

option

-

pass

Option

Description

pass

Allow spam email to pass through.

discard

Discard (block) spam email.

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

config msn-hotmail

Parameter

Description

Type

Size

Default

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

config other-webmails

Parameter

Description

Type

Size

Default

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

config pop3

Parameter

Description

Type

Size

Default

action

Action for spam email.

option

-

tag

Option

Description

pass

Allow spam email to pass through.

tag

Tag spam email with configured text in subject or header.

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

tag-msg

Subject text or header added to spam email.

string

Maximum length: 63

Spam

tag-type

Tag subject or header for spam email.

option

-

subject spaminfo

Option

Description

subject

Prepend text to spam email subject.

header

Append a user defined mime header to spam email.

spaminfo

Append spam info to spam email header.

config smtp

Parameter

Description

Type

Size

Default

action

Action for spam email.

option

-

discard

Option

Description

pass

Allow spam email to pass through.

tag

Tag spam email with configured text in subject or header.

discard

Discard (block) spam email.

hdrip

Enable/disable SMTP email header IP checks for spamfsip, spamrbl, and spambal filters.

option

-

disable

Option

Description

disable

Disable SMTP email header IP checks for spamfsip, spamrbl, and spambal filters.

enable

Enable SMTP email header IP checks for spamfsip, spamrbl, and spambal filters.

local-override

Enable/disable local filter to override SMTP remote check result.

option

-

disable

Option

Description

disable

Disable local filter to override SMTP remote check result.

enable

Enable local filter to override SMTP remote check result.

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.

tag-msg

Subject text or header added to spam email.

string

Maximum length: 63

Spam

tag-type

Tag subject or header for spam email.

option

-

subject spaminfo

Option

Description

subject

Prepend text to spam email subject.

header

Append a user defined mime header to spam email.

spaminfo

Append spam info to spam email header.

config yahoo-mail

Parameter

Description

Type

Size

Default

log-all

Enable/disable logging of all email traffic.

option

-

disable

Option

Description

disable

Disable logging of all email traffic.

enable

Enable logging of all email traffic.