Administrator: /* Basic examples */

2015-12-17T19:36:37Z

Basic examples

← Older revision		Revision as of 19:36, 17 December 2015
Line 169:		Line 169:
	[admin@CableFree] /tool e-mail> set server=10.1.1.1 port=25 from="router@mydomain.com"		[admin@CableFree] /tool e-mail> set server=10.1.1.1 port=25 from="router@mydomain.com"
	</pre>		</pre>
	2. Add new [[M:Scripting#Script_repository \| script]] named "export-send"		2. Add new [[Manual:Scripting#Script_repository \| script]] named "export-send"
	<pre>		<pre>
	/export file=export		/export file=export
Line 175:		Line 175:
	body="$[/system clock get date] configuration file" file=export.rsc		body="$[/system clock get date] configuration file" file=export.rsc
	</pre>		</pre>
	3. Add [[M:System/Scheduler \| scheduler]] to run our script		3. Add [[Manual:System/Scheduler \| scheduler]] to run our script
	<pre>		<pre>
	/system scheduler		/system scheduler

Administrator: /* Summary */

2015-12-17T19:36:12Z

Summary

← Older revision		Revision as of 19:36, 17 December 2015
Line 4:		Line 4:
	==Summary==		==Summary==

	E-mail tool is the utility that allows to send e-mails from the ~~router~~. Tool can be used to send regular configuration backups and exports to network administrator.		E-mail tool is the utility that allows to send e-mails from the CableFree device. Tool can be used to send regular configuration backups and exports to network administrator.

	Email tool uses only plain authentication and tls encryption. Other methods are not supported.		Email tool uses only plain authentication and tls encryption. Other methods are not supported.


	==Properties==		==Properties==

Administrator: Created page with "{{Versions|v3, v4, v5 +}} ==Summary== E-mail tool is the utility that allows to send e-mails from the router. Tool can be used to send regular configuration backups and exp..."

2015-12-17T19:35:59Z

Created page with "{{Versions|v3, v4, v5 +}} ==Summary== E-mail tool is the utility that allows to send e-mails from the router. Tool can be used to send regular configuration backups and exp..."

New page

{{Versions|v3, v4, v5 +}}

==Summary==

E-mail tool is the utility that allows to send e-mails from the router. Tool can be used to send regular configuration backups and exports to network administrator.

Email tool uses only plain authentication and tls encryption. Other methods are not supported.

==Properties==
Sub-menu: <code>/tool e-mail</code>

This submenu allows to set smtp server that will be used.

{{Mr-arg-table-h
|prop=Property
|desc=Description
}}

{{Mr-arg-table
|arg=from
|type=string
|default=<>
|desc=Name or email address that will be shown as receiver.

}}

{{Mr-arg-table
|arg=password
|type=string
|default=""
|desc=Password used for authenticate to SMTP server.

}}

{{Mr-arg-table
|arg=address
|type=IP/IPv6 address
|default=0.0.0.0
|desc=SMTP server's IP address.

}}
{{Mr-arg-table
|arg=port
|type=integer[0..65535]
|default=25
|desc=SMTP server's port.

}}

{{Mr-arg-table-end
|arg=username
|type=string
|default=""
|desc=Username used for authenticate to SMTP server.

}}

{{Note | All server's configuration (if specified) can be overridden by [[#Send | send]] command. }}

==Sending Email==

Command: <code>/tool e-mail send</code>

Send command takes following parameters:

{{Mr-arg-table-h
|prop=Property
|desc=Description
}}

{{Mr-arg-table
|arg=body
|type=string
|default=
|desc=Actual body of the email message
}}

{{Mr-arg-table
|arg=cc
|type=string
|default=
|desc=Send a copy to listed recipients.
}}

{{Mr-arg-table
|arg=file
|type=string
|default=
|desc=Name of the file that will be attached to the email. Only one file can be attached.
}}

{{Mr-arg-table
|arg=from
|type=string
|default=
|desc=Name or email address which will appear as sender. If not specified value from [[#Properties | server's configuration]] is used.

}}

{{Mr-arg-table
|arg=password
|type=string
|default=
|desc=Password used to authenticate to SMTP server. If not specified value from [[#Properties | server's configuration]] is used.

}}

{{Mr-arg-table
|arg=port
|type=integer[0..65535]
|default=
|desc=Port of SMTP server. If not specified, value from [[#Properties | server's configuration]] is used.

}}

{{Mr-arg-table
|arg=server
|type=IP/IPv6 address
|default=
|desc=Ip or IPv6 address of SMTP server. If not specified, value from [[#Properties | server's configuration]] is used.

}}

{{Mr-arg-table
|arg=subject
|type=string
|default=
|desc=Subject of the message.

}}

{{Mr-arg-table
|arg=tls
|type=yes{{!}}no
|default=yes
|desc=Whether to use tls encryption or not.

}}

{{Mr-arg-table
|arg=to
|type=string
|default=
|desc=Destination email address

}}

{{Mr-arg-table-end
|arg=user
|type=string
|default=
|desc=Username used to authenticate to SMTP server. If not specified, value from [[#Properties | server's configuration]] is used.

}}

==Basic examples==

This example will show how to send email with configuration export every 24hours.

1. Configure SMTP server
<pre>
[admin@CableFree] /tool e-mail> set server=10.1.1.1 port=25 from="router@mydomain.com"
</pre>
2. Add new [[M:Scripting#Script_repository | script]] named "export-send"
<pre>
/export file=export
/tool e-mail send to="config@mydomain.com" subject="$[/system identity get name] export) \
body="$[/system clock get date] configuration file" file=export.rsc
</pre>
3. Add [[M:System/Scheduler | scheduler]] to run our script
<pre>
/system scheduler
add on-event="export-send" start-time=00:00:00 interval=24h
</pre>

Send e-mail to server using TLS/SSL encryption. For example, Google mail requires that.

1. configure client to connect to correct server
<pre>
/tool e-mail
set address=173.194.77.108
set port=587
set from=myuser@gmail.com
set user=myuser
set password=mypassword
</pre>

2. send e-mail using send command with tls attribute set to yes

<pre>
send to=myuser@anotherdomain.com subject="email test" body="email test" tls=yes
</pre>

{{cont}}

[[Category:Manual|E]]
[[Category:Tools|E]]

Manual:Tools/email - Revision history

Administrator: /* Basic examples */

Administrator: /* Summary */

Administrator: Created page with "{{Versions|v3, v4, v5 +}} ==Summary== E-mail tool is the utility that allows to send e-mails from the router. Tool can be used to send regular configuration backups and exp..."