Difference between revisions of "Manual:Tools/email"

From MikroTik Wiki
Jump to navigation Jump to search
(more updates)
Line 1: Line 1:
{{Versions|v3, v4, v5 +}}
{{Versions|v3, v4, v5 +}}


<div class=manual>


==Summary==
==Summary==
<p>
 
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 router. Tool can be used to send regular configuration backups and exports to network administrator.  
</p>
 
<p>
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.
</p>




==Properties==
==Properties==
<p id="shbox"><b>Sub-menu:</b> <code>/tool e-mail</code></p>
<p id="shbox"><b>Sub-menu:</b> <code>/tool e-mail</code></p>
<br />
 
<p>
 
This submenu allows to set smtp server that will be used.
This submenu allows to set smtp server that will be used.
</p>
 
{{Mr-arg-table-h
{{Mr-arg-table-h
|prop=Property
|prop=Property
Line 41: Line 38:
{{Mr-arg-table
{{Mr-arg-table
|arg=address
|arg=address
|type=IP ir IPv6
|type=IP/IPv6 address
|default=0.0.0.0:25
|default=0.0.0.0
|desc=SMTP server's IP address.
|desc=SMTP server's IP address.


Line 48: Line 45:
{{Mr-arg-table
{{Mr-arg-table
|arg=port
|arg=port
|type=number
|type=integer[0..65535]
|default=25
|default=25
|desc=SMTP server's port.
|desc=SMTP server's port.
Line 62: Line 59:
}}
}}


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


==Send==
==Sending Email==
<p>
 
Email is sent using following command <code>/tool e-mail send</code>
<p id="shbox"><b>Command:</b> <code>/tool e-mail send</code></p>
</p>
 


Send command takes following parameters:
Send command takes following parameters:
Line 82: Line 79:
|default=
|default=
|desc=Actual body of the email message
|desc=Actual body of the email message
}}
{{Mr-arg-table
|arg=cc
|type=string
|default=
|desc=Send a copy to listed recipients.
}}
}}


Line 104: Line 108:
|default=
|default=
|desc=Password used to authenticate to SMTP server. If not specified value from [[#Properties | server's configuration]] is used.
|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.


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


}}
}}
Line 125: Line 138:
{{Mr-arg-table
{{Mr-arg-table
|arg=tls
|arg=tls
|type=<nowiki>yes|no</nowiki>
|type=yes{{!}}no
|default=yes
|default=yes
|desc=Whether to use tls encryption or not.
|desc=Whether to use tls encryption or not.
Line 143: Line 156:
|type=string
|type=string
|default=
|default=
|desc=Username used to authenticate to SMTP server. If not specified value from [[#Properties | server's configuration]] is used.
|desc=Username used to authenticate to SMTP server. If not specified, value from [[#Properties | server's configuration]] is used.


}}
}}


==Basic examples==
==Basic examples==
<p>
 
This example will show how to send email with configuration export every 24hours.
This example will show how to send email with configuration export every 24hours.
</p>


<p>
 
 
1. Configure SMTP server
1. Configure SMTP server
<pre>
<pre>
[admin@MikroTik] /tool e-mail> set server=10.1.1.1:25 from="router@mydomain.com"
[admin@MikroTik] /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 [[M:Scripting#Script_repository | script]] named "export-send"
Line 168: Line 181:
add on-event="export-send" start-time=00:00:00 interval=24h
add on-event="export-send" start-time=00:00:00 interval=24h
</pre>
</pre>
</p>
 
 
{{cont}}
{{cont}}


</div>


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

Revision as of 10:08, 22 September 2011

Version.png

Applies to RouterOS: 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: /tool e-mail


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

Property Description
from (string; Default: <>) Name or email address that will be shown as receiver.
password (string; Default: "") Password used for authenticate to SMTP server.
address (IP/IPv6 address; Default: 0.0.0.0) SMTP server's IP address.
port (integer[0..65535]; Default: 25) SMTP server's port.
username (string; Default: "") Username used for authenticate to SMTP server.


Icon-note.png

Note: All server's configuration (if specified) can be overridden by send command.


Sending Email

Command: /tool e-mail send


Send command takes following parameters:

Property Description
body (string; Default: ) Actual body of the email message
cc (string; Default: ) Send a copy to listed recipients.
file (string; Default: ) Name of the file that will be attached to the email. Only one file can be attached.
from (string; Default: ) Name or email address which will appear as sender. If not specified value from server's configuration is used.
password (string; Default: ) Password used to authenticate to SMTP server. If not specified value from server's configuration is used.
port (integer[0..65535]; Default: ) Port of SMTP server. If not specified, value from server's configuration is used.
server (IP/IPv6 address; Default: ) Ip or IPv6 address of SMTP server. If not specified, value from server's configuration is used.
subject (string; Default: ) Subject of the message.
tls (yes|no; Default: yes) Whether to use tls encryption or not.
to (string; Default: ) Destination email address
user (string; Default: ) Username used to authenticate to SMTP server. If not specified, value from server's configuration is used.

Basic examples

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


1. Configure SMTP server

[admin@MikroTik] /tool e-mail> set server=10.1.1.1 port=25 from="router@mydomain.com"

2. Add new script named "export-send"

/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

3. Add scheduler to run our script

/system scheduler
add on-event="export-send" start-time=00:00:00 interval=24h


[ Top | Back to Content ]