Model: data/Email

SMTP Server

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

A SMTP server can be configured via the Apps Management menu at the relevant hierarchy to allow VOSS Automate to send email messages.

Email functionality is available for the following:

Quick Add Subscriber (QAS)

When email is enabled in the Global Settings (Email tab), you can select a checkbox on QAS to send a welcome email to new subscribers added via QAS.
File Transfer Destinations

Configured by high level system administrators to to transfer audit data for licensing. See the Licensing and Subscriber Data Export Guide.

Add a SMPT Server

This procedure adds a SMTP server at a hierarchy level.

Prerequisites:

Enable emails in the Global Settings (Email tab).

Perform these steps:

Log in to the Admin Portal, at the hierarchy where you wish to add a SMPT server.

Note

You may only set up one SMTP server at each hierarchy level. Hierarchies below the hierarchy where the SMTP server is set up can use the SMTP server at the hierarchy above; that is, sites can use the SMTP server set up at the customer level.
Go to (default menus) Apps Management > SMTP.
Click the toolbar Plus sign (+) to add a new SMTP server.
On the SMTP Server form, configure details for the new SMTP server:
- Add name for the SMTP server, and a description for the email account.
- Enter the SMTP server hostname and port number.
- Select Secure to use the SSL protocol for establishing a connection to the SMTP server.
- Enter username and password credentials for establishing a connection to the SMTP server.

Related Topics

Email in the Core Feature Guide

This model stores SMTP server connection parameters.

Model Details: data/Email

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title															Description																				Details
Name *															Name for this STMP server.																				Field Name: name Type: String
Description															Description of the Email account.																				Field Name: description Type: String
Hostname *															Hostname of the SMTP server.																				Field Name: host Type: String
Port *															Port of the SMTP server. Default: 587																				Field Name: port Type: String Default: 587
Secure															Uses secure connection.																				Field Name: secure Type: Boolean
Username															Username to use when authenticating for sending email messages.																				Field Name: username Type: String
Password															Password to use when authenticating for sending email messages.																				Field Name: password Type: String Is Password: True Store Encrypted: True