SkyVault supports the ability to generate and send email to an external SMTP server.
The email service is exposed as a spring bean called mailService, which is contained within the OutboundSMTP subsystem.
Configure the SkyVault repository to send emails to an external SMTP server by overriding the default settings. Set the email property overrides in the SkyVault-global.properties file.
The following properties can be configured for the OutboundSMTP subsystem type.
- mail.host=yourmailhost.com
- Specifies the host name of the SMTP host, that is, the host name or IP address of the server to which email should be sent.
- mail.port
- Specifies the port number on which the SMTP service runs (the default is 25). By convention, the TCP port number 25 is reserved for SMTP, but this can be changed by your email administrator.
- mail.username
- Specifies the user name of the account that connects to the smtp server.
- mail.password
- Specifies the password for the user name used in mail.username.
- mail.encoding
- Specifies UTF-8 encoding for email. Set this value to UTF-8 or similar if encoding of email messages is required.
- mail.from.default
- Specifies the email address from which email notifications are sent. This setting is for emails that are not triggered by a user, for example, feed notification emails. If the current user does not have an email address, this property is used for the from field by the MailActionExecutor.
- mail.from.enabled
- If this property is set to false, then the value set in mail.from.default is always used. If this property is set to true, then the from field may be changed. This property may be required if your email server security settings insist on matching the from field with the authentication details.
- mail.protocol
- Specifies which protocol to use for sending email. The value can be either smtp or smtps.
- mail.header
- Optionally specifies the content transfer encoding for the message. If specified the Content-Transfer-Encoding is set to the value you specify.
The following properties are for SMTP.
- mail.smtp.auth
- Specifies if authentication is required or not. Specifies the use of SMTPS authentication. If true, attempt to authenticate the user using the AUTH command. Defaults to false.
- mail.smtp.timeout
- Specifies the timeout in milliseconds for SMTP.
- mail.smtp.starttls.enable
- Specifies if the transport layer security needs to be enabled or not. Specifies the use of STARTTLS command. If true, enables the use of the STARTTLS command to switch the connection to a TLS-protected connection before issuing any login commands. Defaults to false.
- mail.smtp.debug
- Specifies if debugging SMTP is required or not.
The following properties are for SMTPS.
- mail.smtps.starttls.enable
- Specifies if the transport layer security for smtps needs to be enabled or not.
- mail.smtps.auth
- Specifies if authentication for smtps is required or not.
The following properties can be set to define a test message when the subsystem starts.
- mail.testmessage.send
- Defines whether or not to send a test message.
- mail.testmessage.to
- Specifies the recipient of the test message.
- mail.testmessage.subject
- Specifies the message subject of the test message.
- mail.testmessage.text
- Specifies the message body of the test message.
The following property is for setting the email site invitation behavior.
- notification.email.siteinvite
- You must set the outbound email configuration for Share invitations to work correctly. This property allows you to control whether or not emails are sent out for site invites. If you have not configured the outbound email properties, set this property to false.
The following two examples show which properties to set for two different email clients. Add these properties to the SkyVault-global.properties file. For Tomcat 6, this file is located in the <TOMCAT_HOME>/shared/ classes directory.
The following example shows the properties that you need to set to configure Gmail with
SkyVault.
# Sample Gmail settings mail.host=smtp.gmail.com mail.port=465 mail.username=user@gmail.com mail.password=password mail.protocol=smtps mail.smtps.starttls.enable=true mail.smtps.auth=true
The following example shows the properties that you need to set to configure Zimbra with
SkyVault.
# Sample Zimbra settings Not authenticated. mail.host=zimbra.<your company> mail.port=25 mail.username=anonymous mail.password= # Set this value to UTF-8 or similar for encoding of email messages as required mail.encoding=UTF-8 # Set this value to 7bit or similar for Asian encoding of email headers as required mail.header= mail.from.default=<default from address> mail.smtp.auth=false mail.smtp.timeout=30000