Fortinet Document Library

Version:

Version:

Version:

Version:

Version:

Version:

Version:


Table of Contents

CLI Reference

config emailfilter profile

Configure Email Filter profiles.

config emailfilter profile

Description: Configure Email Filter profiles.

edit <name>

set comment {var-string}

set feature-set [flow|proxy]

set replacemsg-group {string}

set spam-log [disable|enable]

set spam-log-fortiguard-response [disable|enable]

set spam-filtering [enable|disable]

set external [enable|disable]

set options {option1}, {option2}, ...

config imap

Description: IMAP.

set log-all [disable|enable]

set action [pass|tag]

set tag-type {option1}, {option2}, ...

set tag-msg {string}

end

config pop3

Description: POP3.

set log-all [disable|enable]

set action [pass|tag]

set tag-type {option1}, {option2}, ...

set tag-msg {string}

end

config smtp

Description: SMTP.

set log-all [disable|enable]

set action [pass|tag|...]

set tag-type {option1}, {option2}, ...

set tag-msg {string}

set hdrip [disable|enable]

set local-override [disable|enable]

end

config mapi

Description: MAPI.

set log-all [disable|enable]

set action [pass|discard]

end

config msn-hotmail

Description: MSN Hotmail.

set log-all [disable|enable]

end

config yahoo-mail

Description: Yahoo! Mail.

set log-all [disable|enable]

end

config gmail

Description: Gmail.

set log-all [disable|enable]

end

config other-webmails

Description: Other supported webmails.

set log-all [disable|enable]

end

set spam-bword-threshold {integer}

set spam-bword-table {integer}

set spam-bwl-table {integer}

set spam-mheader-table {integer}

set spam-rbl-table {integer}

set spam-iptrust-table {integer}

next

end

config emailfilter profile

Parameter

Description

Type

Size

Default

comment

Comment.

var-string

Maximum length: 255

feature-set

Flow/proxy feature set.

option

-

flow

 

Option

Description

flow

Flow feature set.

proxy

Proxy feature set.

replacemsg-group

Replacement message group.

string

Maximum length: 35

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-filtering

Enable/disable spam filtering.

option

-

disable

 

Option

Description

enable

Enable setting.

disable

Disable setting.

external

Enable/disable external Email inspection.

option

-

disable

 

Option

Description

enable

Enable setting.

disable

Disable setting.

options

Options.

option

-

 

Option

Description

bannedword

Content block.

spambwl

Black/white list.

spamfsip

Email IP address FortiGuard AntiSpam black 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.

spam-bword-threshold

Spam banned word threshold.

integer

Minimum value: 0 Maximum value: 2147483647

10

spam-bword-table

Anti-spam banned word table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

spam-bwl-table

Anti-spam black/white list table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

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

spam-iptrust-table

Anti-spam IP trust table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

config imap

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.

action

Action for spam email.

option

-

 

Option

Description

pass

Allow spam email to pass through.

tag

Tag spam email with configured text in subject or header.

tag-type

Tag subject or header for spam email.

option

-

 

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.

tag-msg

Subject text or header added to spam email.

string

Maximum length: 63

config pop3

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.

action

Action for spam email.

option

-

 

Option

Description

pass

Allow spam email to pass through.

tag

Tag spam email with configured text in subject or header.

tag-type

Tag subject or header for spam email.

option

-

 

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.

tag-msg

Subject text or header added to spam email.

string

Maximum length: 63

config smtp

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.

action

Action for spam email.

option

-

 

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.

tag-type

Tag subject or header for spam email.

option

-

 

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.

tag-msg

Subject text or header added to spam email.

string

Maximum length: 63

hdrip

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

option

-

disable

 

Option

Description

disable

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

enable

Enable SMTP email header IP checks for spamfsip, spamrbl and spambwl 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.

config mapi

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.

action

Action for spam email.

option

-

 

Option

Description

pass

Allow spam email to pass through.

discard

Discard (block) spam email.

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 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 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 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 emailfilter profile

Configure Email Filter profiles.

config emailfilter profile

Description: Configure Email Filter profiles.

edit <name>

set comment {var-string}

set feature-set [flow|proxy]

set replacemsg-group {string}

set spam-log [disable|enable]

set spam-log-fortiguard-response [disable|enable]

set spam-filtering [enable|disable]

set external [enable|disable]

set options {option1}, {option2}, ...

config imap

Description: IMAP.

set log-all [disable|enable]

set action [pass|tag]

set tag-type {option1}, {option2}, ...

set tag-msg {string}

end

config pop3

Description: POP3.

set log-all [disable|enable]

set action [pass|tag]

set tag-type {option1}, {option2}, ...

set tag-msg {string}

end

config smtp

Description: SMTP.

set log-all [disable|enable]

set action [pass|tag|...]

set tag-type {option1}, {option2}, ...

set tag-msg {string}

set hdrip [disable|enable]

set local-override [disable|enable]

end

config mapi

Description: MAPI.

set log-all [disable|enable]

set action [pass|discard]

end

config msn-hotmail

Description: MSN Hotmail.

set log-all [disable|enable]

end

config yahoo-mail

Description: Yahoo! Mail.

set log-all [disable|enable]

end

config gmail

Description: Gmail.

set log-all [disable|enable]

end

config other-webmails

Description: Other supported webmails.

set log-all [disable|enable]

end

set spam-bword-threshold {integer}

set spam-bword-table {integer}

set spam-bwl-table {integer}

set spam-mheader-table {integer}

set spam-rbl-table {integer}

set spam-iptrust-table {integer}

next

end

config emailfilter profile

Parameter

Description

Type

Size

Default

comment

Comment.

var-string

Maximum length: 255

feature-set

Flow/proxy feature set.

option

-

flow

 

Option

Description

flow

Flow feature set.

proxy

Proxy feature set.

replacemsg-group

Replacement message group.

string

Maximum length: 35

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-filtering

Enable/disable spam filtering.

option

-

disable

 

Option

Description

enable

Enable setting.

disable

Disable setting.

external

Enable/disable external Email inspection.

option

-

disable

 

Option

Description

enable

Enable setting.

disable

Disable setting.

options

Options.

option

-

 

Option

Description

bannedword

Content block.

spambwl

Black/white list.

spamfsip

Email IP address FortiGuard AntiSpam black 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.

spam-bword-threshold

Spam banned word threshold.

integer

Minimum value: 0 Maximum value: 2147483647

10

spam-bword-table

Anti-spam banned word table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

spam-bwl-table

Anti-spam black/white list table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

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

spam-iptrust-table

Anti-spam IP trust table ID.

integer

Minimum value: 0 Maximum value: 4294967295

0

config imap

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.

action

Action for spam email.

option

-

 

Option

Description

pass

Allow spam email to pass through.

tag

Tag spam email with configured text in subject or header.

tag-type

Tag subject or header for spam email.

option

-

 

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.

tag-msg

Subject text or header added to spam email.

string

Maximum length: 63

config pop3

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.

action

Action for spam email.

option

-

 

Option

Description

pass

Allow spam email to pass through.

tag

Tag spam email with configured text in subject or header.

tag-type

Tag subject or header for spam email.

option

-

 

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.

tag-msg

Subject text or header added to spam email.

string

Maximum length: 63

config smtp

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.

action

Action for spam email.

option

-

 

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.

tag-type

Tag subject or header for spam email.

option

-

 

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.

tag-msg

Subject text or header added to spam email.

string

Maximum length: 63

hdrip

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

option

-

disable

 

Option

Description

disable

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

enable

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

local-override

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

option