Mail Extension User Guide

Size: px

Start display at page:

Download "Mail Extension User Guide"

Charity Green
5 years ago
Views:

1 Version 1.1 July 2017

2 Copyright 2017 PTC Inc. and/or Its Subsidiary Companies. All Rights Reserved. User and training guides and related documentation from PTC Inc. and its subsidiary companies (collectively "PTC") are subject to the copyright laws of the United States and other countries and are provided under a license agreement that restricts copying, disclosure, and use of such documentation. PTC hereby grants to the licensed software user the right to make copies in printed form of this documentation if provided on software media, but only for internal/personal use and in accordance with the license agreement under which the applicable software is licensed. Any copy made shall include the PTC copyright notice and any other proprietary notice provided by PTC. Training materials may not be copied without the express written consent of PTC. This documentation may not be disclosed, transferred, modified, or reduced to any form, including electronic media, or transmitted or made publicly available by any means without the prior written consent of PTC and no authorization is granted to make copies for such purposes. Information described herein is furnished for general information only, is subject to change without notice, and should not be construed as a warranty or commitment by PTC. PTC assumes no responsibility or liability for any errors or inaccuracies that may appear in this document. The software described in this document is provided under written license agreement, contains valuable trade secrets and proprietary information, and is protected by the copyright laws of the United States and other countries. It may not be copied or distributed in any form or medium, disclosed to third parties, or used in any manner not provided for in the software licenses agreement except with written prior approval from PTC. UNAUTHORIZED USE OF SOFTWARE OR ITS DOCUMENTATION CAN RESULT IN CIVIL DAMAGES AND CRIMINAL PROSECUTION. PTC regards software piracy as the crime it is, and we view offenders accordingly. We do not tolerate the piracy of PTC software products, and we pursue (both civilly and criminally) those who do so using all legal means available, including public and private surveillance resources. As part of these efforts, PTC uses data monitoring and scouring technologies to obtain and transmit data on users of illegal copies of our software. This data collection is not performed on users of legally licensed software from PTC and its authorized distributors. If you are using an illegal copy of our software and do not consent to the collection and transmission of such data (including to the United States), cease using the illegal version, and contact PTC to obtain a legally licensed copy. Important Copyright, Trademark, Patent, and Licensing Information: See the About Box, or copyright notice, of your PTC software. UNITED STATES GOVERNMENT RIGHTS PTC software products and software documentation are commercial items as that term is defined at 48 C.F.R Pursuant to Federal Acquisition Regulation (FAR) (a)-(b) (Computer Software) (MAY 2014) for civilian agencies or the Defense Federal Acquisition Regulation Supplement (DFARS) at (a) (Policy) and (a) (Rights in commercial computer software or commercial computer software documentation) (FEB 2014) for the Department of Defense, PTC software products and software documentation are provided to the U.S. Government under the PTC commercial license agreement. Use, duplication or disclosure by the U.S. Government is subject solely to the terms and conditions set forth in the applicable PTC software license agreement. PTC Inc., 140 Kendrick Street, Needham, MA USA

3 Software Change Log... 2 Introduction and Installation... 2 About the Mail Extension... 2 Installing the Mail Extension... 2 Configuration and Usage... 5 Configuration... 5 Usage... 6 Compatibility... 7 Document Revision History

4 Software Change Log Extension Version Release Date Changes 3.1 5/3/2016 Initial Release 3.2 6/17/2016 Upgraded to support TW /21/2016 Upgraded to support TW /8/2017 Added services to send multiple attachments in a single /8/2017 Upgraded to support TW 7.4+ Introduction and Installation Extensibility is a core aspect of the architecture and design of ThingWorx. Partners, third parties, and general ThingWorx users can easily and seamlessly add new functionality into the system. Extensions can be in the form of Services (function/method) Libraries, Connector Templates, Widgets, and more. This document provides installation and usage instructions for the Mail Extension. About the Mail Extension The Mail Extension is a functional helper extension for the ThingWorx platform. With the ThingWorx Mail extension, you can read and send from ThingWorx. Installing the Mail Extension 1. From a Web browser, launch ThingWorx. 2. Log into ThingWorx as an administrator. 2

5 3. Go to Import/Export > Import. 4. Click Choose File and the select extension zip file. 5. Click Import. A validation check screen should appear with green success boxes indicating that the import installed successfully. Note: 6. After import, choose Yes to refresh Composer so the widget will appear in mashup edit mode. 7. Confirm that the Extension has been imported properly. Check the Application Log for potential problems. 8. A validation check screen should appear with green success boxes indicating that the import installed successfully. If it didn t install successfully, you may see this warning: 3

6 This warning means that a previous Mail Extension version is already installed. To upgrade, you will have to remove the old extension and import the new one. Old extensions can be removed under Import/Export > Manage (under the Extensions sub-heading; see the image in step 2). 4

Configuration and Usage Configuration 1. Create a thing using the MailServer thing template. 2. Save the thing and a Configuration tab should appear; click Configuration. 3.

7 Configuration and Usage Configuration 1. Create a thing using the MailServer thing template. 2. Save the thing and a Configuration tab should appear; click Configuration. 3. Click edit so the fields become editable and enter the information required to contact your mail server (Gmail example: SMTP.gmail.com:465 ; POP.gmail.com: 995 ; no TLS, yes SSL): 5

8 4. Be sure to click and enter the same credentials as the specified address. This is the address used to send s. (See the Usage section.) In the case of the Gmail example (and in other cases), the specified account may need to be updated to allow less secure app sign-in (see KCS Article CS200624). 5. To test that it works, save the configuration and go to the Services tab. 6. Next to SendMessage, click Test. 7. Enter a value for the following parameters: subject the subject of the to valid address specifying the recipient of the from the sender of the , which you d like displayed on the itself (for example, donotreply@domain.com (See the Usage section.) body the content of the (this is an XML parameter) 8. Check if an was received by the address specified in the to field. 9. If the didn t send as expected, check out troubleshooting tips in KCS Article CS Usage SMTP packets must be sent from servers designed to communicate in a certain way (mail servers). ThingWorx is not a mail server, but the Mail Extension allows the ThingWorx platform to log in to a mail server based on the given configuration in order to send and receive s. The Configuration tab has fields for each necessary component of this interaction with the mail server: SMTP Server this is the address of the server on which s will be sent SMTP Server Port this is the port through which ThingWorx will log in to the mail server in order to send s POP3 Server this is the address of the server on which s will be received POP3 Server Port this is the port through which ThingWorx will log in to the mail server to check and retrieve s Use TLS indicates the use of a security protocol which involves encrypting information for heightened security o TLS means a by protocol connection, where the program connects first and then uses special commands to enable security Use SSL indicates the use of a different, slightly less secure protocol which also involves encryption 6

9 o Using port 995 with the POP3 protocol implies SSL protocol is being used o By Port security where connection interaction explicitly expects security handshake Mail Account User this is the account that will be accessed in order to send and retrieve s on the given mail servers (must be valid) o This is different from the to field on s o The to field is what the will display for the sender address, and it does not need to be a valid account Mail Account Password must be a valid password for this account Connection Timeout this refers to how long the server should spend trying to log in to the mail server before throwing an exception Operation Timeout this refers to how long ThingWorx should wait when trying to send an before displaying an error (for example, if the SendMessage service is called) Socks Host this is the host name of a SOCKS proxy server if used with the mail server Socks Port this is the port through which ThingWorx will connect to the SOCKS proxy server, if used Attachment File Repository the location in ThingWorx memory that contains attachments on sent s and from received s Compatibility This extension was tested for compatibility with the following ThingWorx version: ThingWorx Version ThingWorx 7.4 and newer Document Revision History Revision Date Version Description of Change 1/16/ Initial Release 6/15/ Update Software Change Log 7

SSH Extension and Terminal Widget User Guide. Version 1.0

SSH Extension and Terminal Widget User Guide Version 1.0 0 Copyright 2016 PTC Inc. and/or Its Subsidiary Companies. All Rights Reserved. User and training guides and related documentation from PTC Inc.