SendGrid mail
A ShareAspace installation has to send emails, especially for inviting users to a Collection or a Space.
Therefore, in order to be able to send emails, it is required to connect the ShareAspace installation to a Mail server. This can be done using the External Extension SendGrid Mail.
It is possible to connect to a SendGrid Mail account using using a SendGridApiKey
that will be obtained when signing up for an account.
The SendGrid Mail component can be installed on the same server where ShareAspace Host and other ShareAspace components are installed but it is recommended to install any External Extension component on a separate machine if possible.
At least one mail component (SendGrid Mail or SMTP Mail) should be configured for a ShareAspace Collection.
Prerequisites
The installation of the ShareAspace SendGrid Mail extension requires to have a machine that is running a Web Server (IIS).
- Software prerequisites for a Send Mail Server (IIS)
Installation steps
Run the installer
Run installer SendGridMail-x.y.z.build.msi
to install the ShareAspace SendGrid Mail extension on a Web Server (IIS).
Configuration
The SendGrid Mail component also needs values to be set for two settings in the appsettings.json
file found in the installation folder for SendGrid Mail (normally at C:\Program Files\Eurostep\ShareAspace\SendGridMail).
SymmetricKey
, that should be used when the component is added as an External Extension.SendGridApiKey
, an api key obtained by the subscription on a SendGrid account.
The SymmetricKey
key should be generated as described in the section
Generate Symmetric Signing Keys.
Below is an example of the settings:
"NovaConfig": {
"SymmetricKey": "lhGnToyYR6S1JYqGvO4E...",
"SendGridApiKey": "dGfU7sI10HOOSuAtu9..."
}
The ShareAspace collection that will use the SendGrid Mail component has to be configured as an Nova Extension before it can be used by that collection.
Note
The SendGrid Mail component must be up and running during the registration process since a manifest exchange will take place between ShareAspace and the extension.
IIS settings
When installing the ShareAspace SendGrid Mail, an Application Pool named "SendGridMail" is created in IIS. By default the account running the Application Pool is the built-in account "LocalSystem".
Note
If another account has to be used for running the "SendGridMail" Application Pool, this account running the "SendGridMail" Application Pool must have read access to the SendGrid Mail installation folder.