eMail Notification
Customizations
eMail Notification
eMail Notification
eMail Notification
This enhancement integrates a feature to
allow CoP users to receive reader-friendly
e-mail notifications in RichText format (as
opposed to the standard text-based
notification of QuickPlace.
eMail Notification
eMail Notification
For Administrators:
• Set up QPMailer.dll.
• Set up QPMailer access to QuickPlace Contacts databases.
• Set up QPMailer.nsf.
Important Notes:
• The CoP Site administrator that will upload the placebot should be
listed in the Managers List and not just be included in a group.
• The CoP Site administrator’s individual name should be listed
otherwise the placebot will not run (this is a QuickPlace bug).
eMail Notification
Setting up QPMailer.dll
• Shutdown Domino server.
• Copy QPMailer.dll to the Notes directory (i.e. C:\Notes\).
• Edit Notes.Ini, add the lines:
QuickPlaceModules=QPMailer.dll
[email protected]
QPMailerDebug=0
QPSERVER=WTQP1
• Restart the Domino Server.
Notes:
• Email address that will be placed under QPMailerAddress is the
internet address assigned to the mail-in database, QPMailer.nsf.
• QPMailerDebug is set to 1 (or any value) only when there is a need
to see the raw data being sent to [email protected] on the Domino
console. Setting this keyword value to 1 will cause the dll to dump
messages to the Domino console.
eMail Notification
Setting up QPMailer access to QuickPlace Contacts databases
• Locate Contacts.ntf from the QuickPlace directory (usually
notes\data\QuicPlace\AreaTypes\).
• Edit ACL of database and add the ID of QPMailer as “READER”. Enclose
the Name in square brackets ([ ]) so that databases created from this
Template will inherit the ACL settings.
• Save changes.
Note: Since the ACL will be changed when there are already existing
QP databases, only QuickPlaces created after the update to the ACL
is created will have the QPMailer ID included in the ACL. All existing
Contacts1.nsf databases of QuickPlaces prior to this change must
be updated manually.
eMail Notification
Setting up QPMailer.nsf
• QPMailer.nsf is a mail-in DB external to Quickplace, default settings is that
this resides on the same location as QPMailer.dll, but any location within
the server will do for as long as the mail address of QPMailer points to this
database.
• QPMailer has several Agents, namely:
• Process QP Mail – Main agent. This agent processes all incoming published
page notifications. This is an event agent to be triggered whenever a new email
is received.
• Manual Process QP Mail – This is a copy of the Process QP Mail agent, but
is manually triggered by a button in the Unprocessed Mail view. Although one
agent can be used for this purpose, we decided to have two copies, one being
manually triggered, so we can have one agent running even if the other is being
updated / modified.
• Send Delivery Failure – This agent is deactivated by default. This agent is a
supplementary agent that will handle Delivery Failure notices that are sent due
to invalid email addresses that QPMailer cannot filter out. It merely forwards the
Delivery Failure notice to the intended recipient.
eMail Notification
Using QPMailer.nsf
• The three custom views for QPMailer are:
• Delivery Failure View – allows the Admin to see which notifications that were
sent to the mail router by QPMailer bounced back.
• Mail Templates View – shows the existing mail templates for custom
notifications, grouped by its Active/Inactive status. This view allows the user to
create a new template and edit or delete an existing template in the view.
• To create a new template: Click on the New Template button.
• To delete an existing template: Select which template needs to be
deleted and click the Delete button.
• To open a template: Double-click on a template document on the view.
• Unprocessed Mail View – The Unprocessed Mail view shows a list of the
emails that QPMailer received but has not been processed yet by the QPMailer
Process Mail agent.
Note: The view offers the user a button to manually start the Mailer Agent that
creates the custom notifications and sends it to the recipients.
eMail Notification
Using QPMailer.nsf
• Delivery Failure View
eMail Notification
Using QPMailer.nsf
• Mail Templates View
eMail Notification
Using QPMailer.nsf
• Mail Templates View
(create/edit a template)
eMail Notification
Using QPMailer.nsf
• Unprocessed Mail View
eMail Notification
Sample eMail Notifications
• Customized
Standard Notification
Notification
Note: The customized notification template is RichText intensive,
allowing administrators to define the font, size, color, and graphical
elements displayed in the email notification sent to users.
eMail Notification
Mail Template Module
• User provides the details of the custom notification using keywords predefined in
the application, to be used as placeholders for the actual values that are to be
fetched from the incoming mails.
eMail Notification
Mail Template Module
• Multiple Notification templates can be created for all the types of Notifications
available. However, only one notification will be “Active” for each type, hence all the
other notifications that will not be used should have the MailType value as “Not
Active”.
• Keywords and parameters are maintained using this facility: System Settings.
• An Admin may create a keyword by clicking the Create -> System Settings on the
File menu.
• Fill up the necessary values and description of the keyword. These default values
are used by the entire database. Please refer to the individual description on how
the keyword is used.
eMail Notification
Mail Process Agent
• The Mail Process Agent is a LotusScript agent that reads incoming notification
emails and applies the assigned template to each mail type, then sends the
customized notification to recipients. To better understand how the Mail Process
Agent works, it is best to describe its pseudo-code.
• Whenever an email is received and belongs to the Unprocessed Mail view, the
following processes are performed:
1. Check the Mail Type of the notification email.
2. Get the Custom Mail Template assigned for the Mail Type.
3. Parse email data and store information in a temporary document.
4. Generate the Recipient List (TO, CC, BCC), as well as the Invalid Recipients list.
5. Get the MIME abstract of the Custom Mail Template.
6. Replace keyword values in the Mail Template abstract with the corresponding values found in the
temporary document.
7. Rebuild the MIME object, and set it as the body of a new Memo Document.
8. Assign the Recipients in the Memo Document.
9. If Invalid Recipients List is not empty, get the notification template for Invalid Recipients.
10. Perform processes 5 till 8
11. Send Customized Notification.
12. Send Invalid Recipient Notification.
eMail Notification
Delivery Failure Agent
• Since QPMailer is acting as a “mail-forwarder”, delivery failure notices that the
mail-in database receives should also be forwarded to the originator of the
notification email.
• When a user creates a notification for a recipient with an email address that is in
the proper format, but is inexistent, the Mail Process agent will not be able to
recognize it as an invalid recipient, and will send the notification to this email
address. As a result of this, the Domino Mail router will try to send the email address
and a corresponding Delivery Failure notice is sent.
• This agent acts merely as a forwarder, and sends the Delivery Failure notice as-is.
This agent is triggered on scheduled basis, and can be disabled if needed.