API / DeviceCount

Entity Description:

PoliteMail places a DeviceCount cookie on the recipient’s device that is used to open a tracked email. For example, PoliteMail counts the number of devices that was used to open a tracked email. (e.g. iPad, desktop, mobile device, etc…)  In other words, the total number of iPads, mobile devices, and desktops that were used to open the email.

 

Properties

Name Description Type Additional
Information
ID Int32
Name String
Count Int32

 

Entity Statement

Creating a DeviceCount
Request
POST /ssv3/odata/DeviceCounts
Content-Type     
application/json
Request body
{
“ID”:”0″,”Name”:”Example Device”,”Count”:”0″
}
Response body
{
“ID”:1,”Name”:”Example Device”,”Count”:0
}
Deleting a DeviceCount
  Request
  DELETE /ssv3/odata/DeviceCounts(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting a DeviceCount
  Request
  GET /ssv3/odata/DeviceCounts(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:1,”Name”:”Example Device”,”Count”:0
}
Updating a DeviceCount
  Request
  PUT /ssv3/odata/DeviceCounts(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0”,”Name”:”Example Device”,”Count”:”0”
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all DeviceCounts
  Request
  GET /ssv3/odata/DeviceCounts
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:0,”Name”:”Example Device”,”Count”:0
},{
“ID”:1,”Name”:”Example Device”,”Count”:0
}]

 

 

API / Event

Entity Description:

All PoliteMail that is distributed is tracked and a record of interactions (e.g. Open and Click counts) with the recipients and the Email is stored and the metadata parsed to capture the metrics for future analysis.

 

Properties

Name Description Type Additional
Information
ID String
OpenCount Int32
ClickCount Int32
EventDate DateTime

 

Entity Statement

Creating an Event
Request
POST /ssv3/odata/Events
Content-Type     
application/json
Request body
{
“ID”:”0″,”OpenCount”:”0″,”ClickCount”:”0″,”EventDate”:”2014-11-20T12:00:00.000Z”
}
Response body
{
“ID”:”1”,”OpenCount”:0,”ClickCount”:0,”EventDate”:”2014-11-20T18:03:00.125Z”
}
Deleting an Event
  Request
  DELETE /ssv3/odata/Event(1)
  Response Headers
  HTTP/1.1 204 No Content
Getting an Event
  Request
  GET /ssv3/odata/Events(1)
  Content-Type     
  application/json
  Response body
  {
“ID”:”1”,”OpenCount”:0,”ClickCount”:0,”EventDate”:”2014-11-20T18:03:00.125Z”
}
Updating an Event
  Request
  PUT /ssv3/odata/Events(1)
  Content-Type     
  application/json
  Request body
  {
“ID”:”0″,”OpenCount”:”0″,”ClickCount”:”0″,”EventDate”:”2014-11-20T12:00:00.000Z”
}
  Response Headers
  HTTP/1.1 204 No Content
Getting all Events
  Request
  GET /ssv3/odata/Events
  Content-Type
  application/json
  Response body
  “value”:[{
“ID”:”0″,”OpenCount”:0,”ClickCount”:0,”EventDate”:”2014-11-20T12:00:00.000Z”
},{
“ID”:”1”,”OpenCount”:0,”ClickCount”:0,”EventDate”:”2014-11-20T18:03:00.125Z”
}]

 

 

Creating the Admin PoliteMail for an Outlook User

Adding the PoliteMail Admin User

Once PoliteMail Server is installed and configured, you will need to create the initial Admin user. When created, this Admin user will be able to connect to the PoliteMail Server from the PoliteMail for Outlook client software, and test the application.

PMMgmntConsoleIcon

 

First, login or RDP into the PoliteMail Server, and launch the PoliteMail Management Console.

 

 

Select User Management and then click Add New 

PoliteMail_Server_Manager

 

 

 

 

 

 

 

 

1.  In the dialog box that opens, input the users Name and Email address information

2.  Important!  Copy the alphanumeric password key to the clipboard

3.  Select Admin from the User-Type drop-down list and click OK

To learn more about user types: http://kb.politemail.com/wp-admin/post.php?post=1167&action=edit

Server_Manager_Edit_User

 

 

 

 

 

 

 

 

4.  Open a text document, and paste in the password key, if the user is not yourself, or if you are creating multiple users at this time, you will also want to copy and paste the email address associated with this key.

5.  Send the User their password key. The PoliteMail for Outlook software is available from the PoliteMail server via a link using this format:

https://your-politemail-server-host-name.com/client.zip

Now install the PoliteMail for Outlook client software, and connect to the PoliteMail Server using the user credentials (email address and password key) you just created.

Learn how to connect the PoliteMail for Outlook client to the PoliteMail Server:  http://kb.politemail.com/wp-admin/post.php?post=1207&action=edit

Note:  Once you have one Admin user connected via the PoliteMail for Outlook client software, all user administration can be done via the Settings controls in Outlook, you do not have manager users on the Server.

Reassigning a License to a Another User

PoliteMail licenses can be reassigned at any time. Simply locate the name of the User to be changed in the PoliteMail Server Manager and click the Edit button. Change the user’s name and email address to reflect the new information, and select a User Type from the drop-down list. Copy the alphanumeric password to the clipboard and paste it in an email that will be sent to the user. The user will then enter the new password into their PoliteMail Server Connection.

Deleting a User

Open the PoliteMail Server Manager, locate the user’s name and click the Delete button.

Note: when deleting a user, the tracking data associated with the user (e.g. all their tracked sent emails and tracking metrics) will be lost. To keep the tracking data associated with the deleted user, reassign the current license to another email address (user). This way the data will be preserved and associated to the new user.

Resetting a Password Key

Occasionally a user will lose their password key, upgrade Outlook, or get a new computer, and will no longer have the original key available. To connect from the PoliteMail for Outlook client software to the PoliteMail Server, the PoliteMail key for that user should be reset to generate a new key.  Simply click Edit on the User in question, and click the Reset button to generate a new key.

Copy the password to the clipboard and paste it into an email that will be sent to the user. The user will then enter the new password into their PoliteMail Server Connection.  If the user also requires the PoliteMail software, you may send a link to it using this format:
https://your-politemail-server-host-name.com/client.zip

Changing a User Type

If a user’s role has changed, you User Type can be changed by utilizing the PoliteMail Server Manager.  Simply access the PoliteMail Server Manager from the desktop, locate the user name from the list and select the new User Type from the drop-down menu. Close the PoliteMail Server Manager to save the changes.