Skip to content
Smarter by Design.Simpler for Business

settings email ​

The settings email command configures the mail server the notifications the device produces will be sent through. When the notification records select the e-mail channel, the messages go over this server.

Command Summary ​

TR7 WEB-CLI · settings email
# Tab after the command
admin@TR7LBWAF01> settings email
show update
 
admin@TR7LBWAF01> settings email show # show the settings
admin@TR7LBWAF01> settings email update … # change
admin@TR7LBWAF01>  

The Server Fields ​

This resource is a single setting: no identifier is written, update is run directly and only the fields to be changed are given.

FieldWhat it doesWhat is written after it
--hostDetermines the address of the mail serverThe server name or IP address
--portDetermines the port of the serverA port number
--securitySelects how the connection will be encryptedSSL · TLS · START TLS. When it is left empty, the connection is made unencrypted
--namespaceSelects which routing table the request will go out fromA routing table (the default is 1)

Authentication ​

FieldWhat it doesWhat is written after it
--authTurns on connecting to the server with authenticationtrue · false (the default is false)
--usernameDetermines the user name to be used in the authenticationA user name
--passwordDetermines the password to be used in the authenticationA password

The Message Fields ​

FieldWhat it doesWhat is written after it
--senderNameDetermines the sender name that will appear in the messageA display name
--senderAddressDetermines the address the message is sent fromAn e-mail address
--subjectDetermines the subject line of the messagesThe subject text
--ccDetermines the carbon-copy recipients to be added to every messageAn e-mail address
--bccDetermines the blind recipients to be added to every messageAn e-mail address

Examples ​

TR7 WEB-CLI · the mail server
# an authenticated and encrypted connection
admin@TR7LBWAF01> settings email update --host smtp.kurum.com.tr --port 587 \
--security "START TLS" --auth true --username tr7-bildirim --password <password> \
--senderName "TR7" --senderAddress tr7@kurum.com.tr --subject "TR7 notification"
 
# a copy of every message should go to the archive
admin@TR7LBWAF01> settings email update --bcc arsiv@kurum.com.tr
admin@TR7LBWAF01>  

Things to Know ​

  • A value with a space requires quotation marks. Values that carry a space such as --security "START TLS" are written inside double quotation marks.
  • The user name is of no use without the authentication being turned on. The --username and --password fields carry meaning together with --auth true.
  • Access to the server depends on the routing table. The mail server must be reachable from the table selected with --namespace.
  • The recipients are determined in the notification records. This command defines only the sending path; who it will go to is in the settings notification records.