Inviting Users

Follow the instructions below to invite selected users:

Prerequsite

Configure the email settings to send out an invitation for existing users to register their device with WSO2 IoTS. Click the below link to get information on configuring the Simple Mail Transfer Protocol (SMTP) before inviting users.

Click here for more information on configuring the email settings.

In WSO2 IoTS, user registration confirmation emails are disabled by default, and the admin needs to provide the required configuration details to enable it.

Create an email account to send out emails to users that register with IoT Server (e.g., no-reply@foo.com).

Open the <IOTS_HOME>/conf/axis2/axis2.xml file, uncomment the mailto transportSender section, and configure the IoTS email account.

<transportSender name="mailto" class="org.apache.axis2.transport.mail.MailTransportSender">
   <parameter name="mail.smtp.host">smtp.gmail.com</parameter>
   <parameter name="mail.smtp.port">587</parameter>
   <parameter name="mail.smtp.starttls.enable">true</parameter>
   <parameter name="mail.smtp.auth">true</parameter>
   <parameter name="mail.smtp.user">synapse.demo.0</parameter>
   <parameter name="mail.smtp.password">mailpassword</parameter>
   <parameter name="mail.smtp.from">synapse.demo.0@gmail.com</parameter>
</transportSender>

For mail.smtp.from, mail.smtp.user, and mail.smtp.password, use the email address, username, and password (respectively) from the mail account you set up.

Example:

<transportSender name="mailto" class="org.apache.axis2.transport.mail.MailTransportSender">
   <parameter name="mail.smtp.host">smtp.gmail.com</parameter>
   <parameter name="mail.smtp.port">587</parameter>
   <parameter name="mail.smtp.starttls.enable">true</parameter>
   <parameter name="mail.smtp.auth">true</parameter>
   <parameter name="mail.smtp.user">foo</parameter>
   <parameter name="mail.smtp.password">$foo1234</parameter>
   <parameter name="mail.smtp.from">no-reply@foo.com</parameter>
</transportSender>

Optionally, configure the email sender thread pool.
Navigate to the email-sender-config.xml file, which is in the <IOTS_HOME>/conf/etc directory, and configure the following fields under <EmailSenderConfig>.
- MinThreads: Defines the minimum number of threads that needs to be available in the underlying thread pool when the email sender functionality is initialized.
- MaxThreads: Defines the maximum number of threads that should serve email sending at any given time.
- KeepAliveDuration: Defines the duration a connection should be kept alive. If the thread pool has initialized more connections than what was defined in MinThreads, and they have been idle for more than the KeepAliveDuration, those idle connections will be terminated
- ThreadQueueCapacity: Defines the maximum concurrent email sending tasks that can be queued up.
Example:
```
<EmailSenderConfig>
   <MinThreads>8</MinThreads>
   <MaxThreads>100</MaxThreads>
   <KeepAliveDuration>20</KeepAliveDuration>
   <ThreadQueueCapacity>1000</ThreadQueueCapacity>
</EmailSenderConfig>
```
Optionally, customize the email templates that are in the <IOTS_HOME>/repository/resources/email-templates directory.

The email template functionality of WSO2 IoT Server is implemented on top of Apache Velocity, which is a free and open-source template engine.
1. Open the email template that you wish to edit based on the requirement, such as the user-invitation.vm or user-registration.vm file.
2. Edit the <Subject> and <Body> to suite your requirement.
3. Restart WSO2 IoT Server.
If you need to access HTTP or HTTPS base URLs of the server within your custom template configs, use the $base-url-http and $base-url-https variables, respectively.

Sign in to the WSO2 IoTS device management console.
Click View under USERS to view the list of users.

For more information see, viewing users.
Search for users you wish to invite, select them by clicking the respective users and click Invite Selected.
Click Select, to select the users click on the users you wish invite, and click Invite Selected.

An invitation will be sent to the selected user/s, only if the email client has been configured prior to carrying out this action.
Click Yes to confirm.