RevMail - Documentation

A guide to setting up RevMail units for email campaigns

The RevMail unit code consists of 2 URLs - a click URL (preceded by "a href=") & an image URL (preceded by "img src=").

Sample RevMail Code Template:

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0"/>
 </a>
</div>


Setting your code up is just a matter of replacing the italicized placeholder values of the 4 required parameters (in bold) based on your configuration preferences.



The 4 Required Parameters & what to input for their values:

 

id - your widget ID, provided by your account rep.

ℹ️ EXAMPLE

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0"/>
 </a>
</div>
  • Needs to be included within both click & image URLs

 

key - a unique identifier (UUID) for stats accuracy

ℹ️ EXAMPLE

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key={user_id}{campaign_id}&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key={user_id}{campaign_id}&total=1&offset=0"/>
 </a>
</div>
  • Needs to be included within both click & image URLs
  • "Key" values are unique identifiers used to differentiate each of your email recipients. They can be any unique alpha numeric string of your choosing, just as long as each string is unique to each recipient. You can use your email provider's personalization tags/variables to automatically populate these unique values upon delivery. While there are many different tags/variables that can be used to accomplish this, one common example would be to use your email provider's Subscriber ID tag/variable. Below you can find detailed examples based on the email provider you're using.
  • Please note that the "key" values expire 24 hours after your email campaign is delivered. Therefore if you're sending out more than 1 email to the same recipients within a 24 hour period, you will need to add a second tag/variable to differentiate each recipient AND email. For example, rather than using only a Subscriber ID tag/variable, you would add in another such as Email ID so that the value assigned to each recipient is also unique to each email.

 

total - the total number of ads you'll be displaying within the newsletter. Used to prevent duplicate content from appearing when displaying multiple ad panels within the same email. Defaults to "1" when nothing is specified

ℹ️ EXAMPLE (if you were displaying 2 ad panels within the same email)

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=2&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=2&offset=0"/>
 </a>
</div>

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=2&offset=1">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=2&offset=1"/>
 </a>
</div>
  • Needs to be included within both click & image URLs

 

offset - the index used to identify each individual ad placement. Used to prevent duplicate content from appearing when displaying multiple ad panels within the same email. Defaults to "0" when nothing is specified

ℹ️ EXAMPLE (if you were displaying 3 ad panels within the same email)

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=3&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=3&offset=0"/>
 </a>
</div>

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=3&offset=1">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=3&offset=1"/>
 </a>
</div>

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=3&offset=2">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=3&offset=2"/>
 </a>
</div>
  • Needs to be included within both click & image URLs
  • ✴️ The index starts at "0". So your highest "offset" value will always be one less than your "total" value
  • If your "total" value is set to "1", offset will have no affect

 

That covers everything required to get your RevMail units up and running. For additional customization options feel free to continue on to our optional parameters section. Otherwise you should now have everything needed to start displaying ads within your email campaigns. 

______________________________________________________________________________________

Optional Parameters:

 

size -  your preferred unit dimensions.

ℹ️ EXAMPLE

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0&size=300x250"/>
 </a>
</div>
  • Only needs to be included within the image URL
  • Supported IAB sizing options: 250x250, 240x400, 336x280, 720x300, 300x600, 970x250, 970x550, 400x100, 400x150, 570x150, 600x250, 600x300 

 

internal - allows you to run your own internal content in place of sponsored content
ℹ️ EXAMPLE
<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0&internal=1"/>
</a>
</div>
  • Only needs to be included within the image URL
  • Value can either be "1" or "true". Both will function the same way.

 

headline_color - allows you to specify a custom headline text color.

ℹ️ EXAMPLE

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0&headline_color=0000FF"/>
 </a>
</div>
  • Only needs to be included within the image URL
  • Can be any hex color value without a hash

 

headline_size - allows you to specify a headline font size. Please note this parameter will not work when specifying IAB sizes

ℹ️ EXAMPLE

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0&headline_size=18"/>
 </a>
</div>
  • Only needs to be included within the image URL
  • Can be any numerical pixel value

 

headline_font_style - allows you to make the font-weight bold. Please note this parameter will not work when specifying IAB sizes

ℹ️ EXAMPLE

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0&headline_font_style=bold"/>
 </a>
</div>
  • Only needs to be included within the image URL

 

provider_color - allows you to specify a custom provider text color.

ℹ️ EXAMPLE

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0&provider_color=0000FF"/>
 </a>
</div>
  • Only needs to be included within the image URL
  • Can be any hex color value without a hash

 

button_color - allows you to specify a custom button color. Please note that only layout 1 populates a button.

ℹ️ EXAMPLE

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0&button_color=0000FF"/>
 </a>
</div>
  • Only needs to be included within the image URL
  • Can be any hex color value without a hash

 

hide_button - allows you to hide the "Learn More" button. Please note that only layout 1 populates a button. Buttons are automatically hidden on layouts 2 and 3.

ℹ️ EXAMPLE

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0&hide_button=true"/>
 </a>
</div>
  • Only needs to be included within the image URL

 

hide_provider - allows you to hide the name of the content provider
Only needs to be included within the image URL

ℹ️ EXAMPLE

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0&hide_provider=true"/>
 </a>
</div>
  • Only needs to be included within the image URL

 

sub_ids - Sub ID tracking is a useful tool that can be customized to achieve your reporting needs. Some of the ways Publishers successfully utilize Sub ID reporting include tracking revenue by article, traffic source, social influencer, or to evaluate performance on different page variations.

ℹ️ EXAMPLE

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0&sub_ids=[key_01:value_01,key_02:value_02]">
 <img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0&sub_ids=[key_01:value_01,key_02:value_02]"/>
 </a>
</div>
  • Needs to be included within both click & image URLs

Optional Layouts:

 

layout - allows you to select from 1 of 7 predefined ad layouts (defaults to 1)

ℹ️ EXAMPLE

<div>
<a href="https://revmail.revcontent.com/click/?id=1234&key=abc123&total=1&offset=0">
<img src="https://revmail.revcontent.com/?id=1234&key=abc123&total=1&offset=0&layout=3"/>
 </a>
</div>
  • Only needs to be included within the image URL

      

layout=1 (default)

  • Image top, text & button bottom

layout=2

  • Text left, image right
layout=3
  • Image left, text right
Screen Shot 2023-08-15 at 2.37.52 PM

layout=4

  • Image only, no text

layout=5

  • Text only, no image

layout=7

  • Thumbnail image top, text bottom
  • Used for smaller thumbnail image sizes
layout=8
  • Optimized for 300x250
  • Text within image
Screen Shot 2022-09-14 at 9.52.26 AM