cspace-config email

Owned by Chris Martin (Unlicensed)
Aug 31, 2011
2 min read

What is Email section of the Cspace Config

Email section specifies the content for the password reset email as well as information about smtp etc

Where is Email section of the Cspace Config

part of cspace-config usually found in the tenant specific local settings

Structure

    <email>
        <baseurl></baseurl>
        <from></from>
        <to></to>
        <!-- if specified then all emails will send to this address - used for debugging -->
        <smtp>
            <host>localhost</host>
            <port>25</port>
            <debug>false</debug>
            <auth enabled="false">
                <!-- set to true if wish to use auth -->
                <username></username>
                <password></password>
            </auth>
        </smtp>
        <passwordreset>
            <token>
                <daysvalid>7</daysvalid>
            </token>
            <loginpage>/collectionspace/ui/lifesci/html/index.html</loginpage>
            <subject>CollectionSpace Password reset request</subject>
            <message></message>
	</passwordreset>
    </email>
</admin>
Single Elements

MUST HAVE

baseurl
  • string
  • no default
  • used in the email content
from
  • string
  • no default
  • email address which the emails will say they are from

CAN HAVE

to
  • string
  • no default
  • if a to address is specified then all emails will be sent to this address instead of the specific user. This is used when you wish to debug the site and check what emails are being sent.
Complex Elements SMTP

used to set up smtp

host
  • string
  • no default
  • smtp host (mail.smtp.host)
port
  • string
  • no default
  • smtp port (mail.smtp.port)
debug
  • boolean
  • default false
  • sets the Property mail.debug
auth
  • sets the Property mail.smtp.auth
Complex Elements passwordreset

used in password reset functionality

loginpage
  • string
  • no default
  • url of the login page for password reset functionality - this is usually the main login page
subject
  • string
  • no default
  • Subject line of the email sent
message
  • string
  • no default
  • content of the reset email to be sent.
    • greeting will be replaces by the users name
    • link will be replaced by a url created from baseurl and loginpage and the token

    • n should force a new line in the email
token/daysvalid
  • number
  • default 7
  • number of days that the token sent in the password reset email will be valid