CLI command: Mail

In dieser Seite werden die Variablen für unterschiedliche Sprachen definiert.
Diese Seite wird auf folgenden Seiten eingebunden

• UTM/EXTRAS/CLI (← links)
• Mail cli v11 (← links)

---

Syntax for the CLI command Mail

Last adaption: 06.2024

New:

• layout adjustment

notempty

This article refers to a Beta version

v11

Access: UTM-IP:Port or UTM-URL:Port
Port as configured at Network / Appliance Settings / Webserver
Default-Port: 11115
i.e.: https://utm.ttt-point.de:11115
Default: https://192.168.175.1:11115 Extras CLI

---

Command	Parameters	Description	Example
mail filterng mail filterng new mail filterng new		Creates a new mail filter rule	mail filterng selector new name virusfilter binop AND
		A rule is created with several commands. The command mail filterng selector new first creates the rule with a name and link condition.	mail filterng selector item new selector virusfilter type PROTO operator IS value [ SMTP ]
		mail filterng selector item new sets the individual filters.	mail filterng selector item new selector virusfilter type VIRUS operator TRUE
		mail filtering new then defines the action and position	mail filterng new selector virusfilter action REJECT pos 1
	pos	Postion number of the rule
	selector	Name of the filter rule
	action	Action of this rule	ACCEPT; MARK; FILTER; BLOCK; REJECT; QUARANTINE
	action_arg	Specifies the text to be used to mark the email in the subject line of the MARK action
	operator	Content matching such as: is, is not, contains, does not contain, matches regex	IS; ISNOT; IN; NOTIN; REGMATCH; TRUE; FALSE
	type	Type of content	PROTO; SRC; DST; FROM; RCPT; HEADER; SPAM; VIRUS; URL; CONTENT
	type_arg	Additional information about the type of content	MIME; SUFFIX
	value	Content to be filtered
	binop	Should all conditions apply or just one of them?	AND; OR
mail filterng delete mail filterng delete		Deleting a mail filter rule	mail filterng delete id "3"
	id	Id of the mail filter rule
mail filterng get mail filterng get		Lists the mail filter rules	mail filterng get mail filterng selector get mail filterng selector item get
mail filterng set mail filterng set		Changing a mail filter rule	mail filterng set id "3" action "DROP"
	id	Id of the mail filter rule
	pos	Postion number of the rule
	selector	Name of the filter rule
	action	Action of this rule	ACCEPT; MARK; FILTER; BLOCK; REJECT; QUARANTINE
	action_arg	Specifies the text to be used to mark the email in the subject line of the MARK action
	operator	Content matching such as: is, is not, contains, does not contain, matches regex	IS; ISNOT; IN; NOTIN; REGMATCH; TRUE; FALSE
	type	Type of content	PROTO; SRC; DST; FROM; RCPT; HEADER; SPAM; VIRUS; URL; CONTENT
	type_arg	Additional information about the type of content	MIME; SUFFIX
	value	Content to be filtered
	binop	Should all conditions apply or just one of them?	AND; OR
mail filterng update mail filterng update		Update the mail filter rules	mail fitlerng update
mail dkimsign mail dkimsign get mail dkimsign get		Output of the DKIM signature configuration	mail dkimsign get
mail dkimsign update mail dkimsign update		Updates the DKIM signature configuration	mail dkimsign update
mail dkimsign domain mail dkimsign domain get mail dkimsign domain get		Output of the DKIM signature configuration	mail dkimsign domain get
mail dkimsign domain set mail dkimsign domain set			mail dkimsign domain set
mail archive mail archive update mail archive update		Updates the variables of the mail archive	mail archive update count "1024" age "7" size "128"
	count	Maximum number of emails
	age	Maximum email age in days
	size	Maximum email size in megabytes
mail archive get mail archive get		Listing of emails in the mail archive	mail archive get
mail archive count mail archive count		Outputs the number of emails stored in the archive	mail archive count
mail archive resend mail archive resend		Resending an email from the archive	mail archive resend <name> <rcpt>
mail archive content get mail archive content get		Output of the contents of an email	mail archive content get name "smtp.hkHTSk"
	name	Email subject/name
mail archive preview mail archive preview		Displays the contents of an email	mail archive preview name "smtp.hkHTSk"
	name	Email subject/name
mail archive senders mail archive senders		Displays the sender of an email	mail archive senders name "smtp.hkHTSk"
	name	Email subject/name
mail archive recipients mail archive recipients		Displays the recipients of an email	mail archive recipients name "smtp.hkHTSk"
	name	Email subject/name
mail queue mail queue get mail queue get		Shows the mail queue	mail queue get
mail queue delete mail queue delete		mail queue delete--desc	mail queue delete id u35CIFQk006986
	id	ID of the email
mail queue flush mail queue flush		Attempts to redeliver the emails from the mail queue	mail queue flush id u35CLSQk007559 rcpts user@ttt-poit.de
	id	ID of the email
	rcpts	mail queue rcpts--desc
mail fetch mail fetch get mail fetch get		Lists all Fetchmail servers	mail fetch get
mail fetch new mail fetch new		Adds a new Fetchmail server	mail fetch new...
mail fetch set mail fetch set			mail fetch set id "7" user "homer" pass "insecure"
	id	ID of the Fetchmail server (cannot be changed, is required) to identify the server to be edited.
	host	Hostname of the Fetchmail server
	proto	Fetchmail server log	POP3; IMAP
	user	Username
	pass	Password
	flags	Flags of the configuration	MULTIDROP; STARTTLS; KEEPMAILS; BADHEADER; SSL_CERT_CHECK
	dest_addr	Target email address
	dest_domain	Target domain (replaces dest_addr when multidrop was used)
	envelope	Envelope-Header (Only for multidrop use)	Envelope-To; Delivered-To; X-Envelope-To; X-Delivered-To; X-Rcpt-Original; X-Original-To; X-Orig-To; X-Originally-To
	limit	Maximum message size in megabytes
	local	Local email addresses for multidrop
	local	Local email addresses for multidrop
	remote	Remote email addresses for multidrop
	oauth_account_user_id	mail fetch-oauth_account_user_id--desc
	oauth_account	mail fetch-oauth_account--desc
	oauth_user	mail fetch-oauth_user--desc
	tls_version	TLS Version	TLS1.2; TLS1.2+; TLS 1.3;...
mail fetch delete mail fetch delete		Deleting a Fetchmail server	mail fetch delete id "7"
	id	ID of the Fetchmail server (cannot be changed, is required) to identify the server to be edited.
mail fetch map mail fetch map set mail fetch map set		Adding or changing a user mapping	mail fetch map set id "7"...
	id	mail fetch map-id--desc
mail fetch map delete mail fetch map delete		Deleting a user mapping	mail fetch map delete id "7"
	id	mail fetch map-id--desc
mail fetch update mail fetch update		Updating the Fetchmail configuration	mail fetch update
mail fetch envelop get mail fetch envelop get		Output of all Envelop header configuration options	mail fetch envelop get
mail stats mail stats get mail stats get		Displays email statistics	mail stats get
mail stats users mail stats users		Outputs the email users	mail stats users
mail rescan mail rescan get mail rescan get		mail rescan get--desc	mail rescan get