Email permalinks
To better support links in email templates, from ver 5.9, PageSeeder provides permalinks that redirect users to the correct URL in the user interface.
This insulates custom email templates from future updates to the user interface, and improves forward compatibility.
Path and parameters
The path for all permalinks is, the site prefix, followed by /email, for example:
/ps/email
Some permalinks require specific parameters. All parameters included in the permalink URL are forwarded to the target URL.
The parameters values are usually supplied in the email XML source content.
Parameter member
The ID or username of a member, this value is usually available in the<member>or<author> element.
Parameter group
The ID or name of a group, this value is usually available in the <group> or<project> element.
Parameter comment
The ID of a comment, this value is usually available in the <comment>element.
Parameter uri
The ID of a URI (document), this value is usually available in the<uri>element.
Parameter fragment
The ID of a fragment. If applicable, this will be the value of the @fragmentattribute on the <context> element.
Parameter token
A security token to allow temporary PageSeeder access without login credentials. The value of a token is URL-safe (it doesn’t require URL encoding). All tokens expire – and although one can be read multiple times, it can only save once.
After issue, PageSeeder expresses the token as an attribute of the <notification> element.
To track usage, there is a record of each token that PageSeeder issues.
Summary
The following table lists minus the site and email prefix (for example, /ps/email).
| Permalink | Parameters | PageSeeder equivalent | Target |
|---|---|---|---|
/changeemail | member token | /ui/m/{member}/email.html | Confirmation page acknowledging a change of email address |
/changepassword | member token | /ui/m/{member}/password.html | Input page for a user to enter a new password. |
/comment | group | /ui/g/{group}/discussions/{comment}.html | Page to display a single comment thread, with an option to reply. |
/comments | group | /ui/g/{group}/discussions.html | Page to display a list of comments for a group (for list-archive header) |
/download | uri | /ui/d/{uri}/download.html | To download a document. |
/getstarted | member token | /ui/m/{member}/getstarted.html | Onboarding page for new users to enter details, set password, accept terms of use and activate account. |
/home | group | /ui/g/{group}/home.html | Group homepage |
/members | group | /ui/g/{group}/admin/members.html | List of group members. |
/moderatecomment | group comment | /ui/g/{group}/discussions/{comment}/moderate.html | Input page for moderators to accept, or reject, comments. |
/moderatemember | group member | /ui/g/{group}/admin/members/{member}/moderate.html | Input page for moderators to accept, or reject, applications to become a group member. |
/mydetails | /ui/account/personal.html | Account page for a user to update their personal details | |
/mygroups | /ui/account/memberships.html | Account page for a user to update their group subscription and notification settings | |
/myinvitation | group | /ui/account/memberships.html?group={group} | Account page for a user to accept, or reject, an invitation to a group |
/myoptions | /ui/account/personal.html | Account page for general options such as, whether to deliver email attachments as a link or a file, or to invoke the vacation feature. | |
/newcomment | group | /ui/g/{group}/discussions.html?form=true | Page to create a comment in a group (for list-post header) |
/unsubscribe | group | /ui/unsubscribe.html?group={group} | An unsubscribe page. |
/unsubscribe (POST) |
| /api/groups/{groups}/unsubscribe.json | Service for one-click unsubscribe. Requires PageSeeder v6.1 or higher. |
/uri | group | /ui/g/{group}/d/{uri}.html | Page to display the context document. |
/workflow | group | /ui/g/{group}/d/{uri}.html?workflow | Page to display the document workflow. |
Examples
Subscription options
To redirect users to subscription options that control the emails they receive from a group, construct the permalink as:
https://ps.acme.com/ps/email/myoptions
New members
Redirect new members to the “Get started” or “Activation” page by:
- Extracting the token from
<notification token="Zu5nMVxo-s_LHy-9-0eVS3bwKl3wEp1f">and the member ID from the<member id="123">. - Constructing the permalink as:
https://ps.acme.com/ps/email/getstarted?member=123&token=Zu5nMVxo-s_LHy-9-0eVS3bwKl3wEp1f
Until the token expires, or is used, a user can follow the link to access the page.