EmailExport¶
SpaceObServer.Application.EmailExport¶
Description¶
Allows you send any SpaceObServer statistic (lists and charts) via email.
Syntax¶
EMailExport (Statistics : <String>, [optional]SendTo <String>, [optional]Subject <String>, [optional]MailBodyFormat <String>, [optional]SendFrom <String>, [optional]Server <String>, [optional]Port <Integer>, [optional]UseSSL <Boolean>, [optional]Username <String>, [optional]Password <String>)
Parameters¶
- Statistics
A semicolon separated list of charts and lists, which should be included in Email. The table of the Export Statistics lists all accessible types of charts and lists.
- [optional]SendTo
(Optional Parameter) The email address the report will be sent to.
- [optional]Subject
(Optional Parameter) The subject of the email. Supports environment variables such as
%DATE%,%TIME%or%USERNAME%.- [optional]MailBodyFormat
(Optional Parameter) Determines the body format of the mail. This parameter can be one of the following strings:
"html": Sends a html formatted email."text": Sends the email as plain text.
- [optional]SendFrom
(Optional Parameter) The email address that will be shown as the sender of the report.
- [optional]Server
(Optional Parameter) The name (DNS) or IP address of the machine hosting the SMTP service through which messages are to be sent.
- [optional]Port
(Optional Parameter) The port on which the SMTP service specified in the “Server” field is listening for connections.
- [optional]UseSSL
(Optional Parameter) Indicates that Secure Sockets Layer (SSL) should be used when sending messages via SMTP.
- [optional]Username
(Optional Parameter) Select this option if SMTP service specified by the Server field requires authentication.
- [optional]Password
(Optional Parameter) Select this option if SMTP service specified by the Server field requires authentication.
Example¶
1.)
$SOS.EmailExport("detailslist")
SOS.EmailExport "detailslist"
Sends the ‘Details’ list, containing all the columns chosen in the Options dialog via email using the emails settings from the Options dialog.
2.)
$SOS.EmailExport("scantree; detailslist; piechart; historychart", "Someone@example.com", "SpaceObServer OLE Report","html", "SpaceObServer@example.com","smtpserver", "25", $false)
SOS.EmailExport "scantree; detailslist; piechart; historychart", "Someone@example.com", "SpaceObServer OLE Report","html", "SpaceObServer@example.com","smtpserver", 25, false
Sends an email with the directory tree, the details list, the pie chart, and the history chart of the current root to “Someone@example.com”. Subject of the email is “SpaceObServer OLE Report”. The email is html formatted and sent from “SpaceObServer@example.com”. The mail is sent by using the server “smtpserver” via port 25. The SSL encryption is deactivated.