Add-on Documentation from JCOGS Design

ConfigurationLast updated: 13 March 2022

Configuration of the add-on is required before it can be used.

Configuration is controlled using the add-on settings page which can be accessed from the ExpressionEngine Control Panel Add-ons page.

Main Settings

Enable or disable OTP - Does what it says on the tin...

Member Role where OTP Use is Required - Choose a member role for which use of OTP will be required. If the members you want to be required to use OTP do not match a current role group perfectly, simply create a new member role and associate them with that new Role.

Member Role where OTP Use is Optional - Choose a member role for which use of OTP will be optional. If the members you want to be required to use OTP do not match a current role group perfectly, simply create a new member role and associate them with that new Role.

Email Settings

Allows you to specify which email account should be used to send the OTP emails. The emails themseleves will be sent using whatever outbound email settings are in place on the EE system, so this information is primarily for information purposes: the email credentials do not have to link to the EE server at all if you do not want them to. Some email spam checking systems will mark-down messages that contain obviously spurious email credentials, so making a sensible choice here will help ensure the OTP system works well.

Enable sending of OTPs by email - Does what it says on the tin...

Name of Email Sender - Choose the name for the email sender that will be shown when OTP code email arrives.

Email Address of Email Sender - Choose the sender's email address for the OTP code email.

Advanced Email Options

Subject line for OTP emails - The subject line of emails sent by EE-OTP always begins with the Site Label followed by whatever text is specified here. By default this additional text is set to "One-Time Password".

Email preamble - A paragraph of text that is included in the OTP code email immediately before the line containing the OTP code itself. By default this left blank.

OTP Code Prefix - Text that will immediately preceed the OTP code in the email. By default it is set to "Your OTP Code: ".

Email Closing - A paragraph of text that is included in the OTP code email immediately after the line containing the OTP code itself. By default this left blank.

Change email Reply-To settings

Allows you to specify an email account to which replies to the OTP email should be directed. If this is not specified then most email systems will direct the reply to the email address given for the sender.

Name of Reply-To Account - Choose the name for the email sender that will be shown when OTP code email arrives.

Email Address of Email Sender - Choose the sender's email address for the OTP code email.