Fix for OPENDJ-273: Account status notification makes more sense in the Acc...

Mark Craig

06.40.2011 360f22a5692c5a669bff75a98fdfaa02e7baa956

Fix for OPENDJ-273: Account status notification makes more sense in the Account Lockout chapter rather than the Password Policy chapter

 opendj3/src/main/docbkx/admin-guide/chap-account-lockout.xml

@@ -143,5 +143,44 @@
  </procedure>
 </section>

 <section>
  <title>Managing Account Status Notification</title>
  
  <para>OpenDJ can send mail about account status changes. OpenDJ needs an
  SMTP server to send messages. By default, message templates are in
  English.</para>
  
  <procedure>
   <title>To Mail Users About Account Status</title>
   
   <step>
    <para>Identify the SMTP server to which OpenDJ sends messages.</para>
    <screen>$ dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
 set-global-configuration-prop --set smtp-server:smtp.example.com -X -n</screen>
   </step>
   
   <step>
    <para>Set up OpenDJ to be able to mail users about account status.</para>
    <screen>dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
 set-account-status-notification-handler-prop
 --handler-name "SMTP Handler" --set enabled:true
 --set email-address-attribute-type:mail -X -n</screen>
    <para>You can also configure the <literal>message-subject</literal> and
    <literal>message-template-file</literal> properties. Try interactive
    mode if you plan to do so.</para>
    <para>You find templates for messages by default under the
    <filename>config/messages</filename> directory. You can edit the templates
    to suit your purposes.</para>
   </step>
   
   <step>
    <para>Adjust applicable password policies to use the account status
    notification handler you configured.</para>
    <screen>$ dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
 set-password-policy-prop --policy-name "Default Password Policy"
 --set account-status-notification-handler:"SMTP Handler" -X -n</screen>
   </step>
  </procedure>
 </section>
</chapter>


 opendj3/src/main/docbkx/admin-guide/chap-pwd-policy.xml

@@ -330,38 +330,6 @@
pwdPolicySubentry: cn=Root Password Policy,cn=Password Policies,cn=config</screen>
   </step>
  </procedure>
  
  <procedure>
   <title>To Mail Users About Account Status</title>
   
   <step>
    <para>Identify the SMTP server to which OpenDJ sends messages.</para>
    <screen>$ dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
 set-global-configuration-prop --set smtp-server:smtp.example.com -X -n</screen>
   </step>
   
   <step>
    <para>Set up OpenDJ to be able to mail users about account status.</para>
    <screen>dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
 set-account-status-notification-handler-prop
 --handler-name "SMTP Handler" --set enabled:true
 --set email-address-attribute-type:mail -X -n</screen>
    <para>You can also configure the <literal>message-subject</literal> and
    <literal>message-template-file</literal> properties. Try interactive
    mode if you plan to do so.</para>
    <para>You find templates for messages by default under the
    <filename>config/messages</filename> directory. You can edit the templates
    to suit your purposes.</para>
   </step>
   
   <step>
    <para>Adjust applicable password policies to use the account status
    notification handler you configured.</para>
    <screen>$ dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
 set-password-policy-prop --policy-name "Default Password Policy"
 --set account-status-notification-handler:"SMTP Handler" -X -n</screen>
   </step>
  </procedure>
 </section>
</chapter>