MyListing Email Reports
The {CODICTS} MyListing Email Reports plugin automatically sends periodic email reports to listing owners on your MyListing site. Each report contains the user’s listing performance statistics — including views, unique views, device breakdowns, visitor countries, referral sources, and more — rendered in a professionally styled HTML email.
Installation & Activation
Start by downloading the plugin from the Downloads page on your dashboard on the CoDicts website.
After downloading, install and activate the plugin in WordPress by navigating to “Plugins” > “Add New” > “Upload Plugin” and selecting the downloaded zip file. Click “Install Now” and then “Activate”.
Once activated, navigate to Listing Types → Settings → Notifications in the WordPress admin. Enable the “Notify users on their listing reports” notification and configure your schedule.
Key Features
| Feature | Description |
|---|---|
| Automated Monthly Reports | Sends professionally styled HTML emails to listing owners with their complete listing statistics on a configurable monthly schedule. |
| Flexible Scheduling | Choose to send reports on the 1st, 15th, or last day of each month, at any hour of the day. |
| MyListing Stats Integration | Uses MyListing’s built-in statistics engine for consistent data — the same stats users see on their dashboard. |
| User Opt-In / Opt-Out | Users can opt in or out via their WordPress profile or WooCommerce account page. |
| One-Click Unsubscribe | Each email includes a unique unsubscribe link that immediately opts the user out. |
| Test Email | Send a test email to any address directly from the settings panel to preview the report. |
| Custom Template Override | Override the default email template by placing a custom template in your theme’s directory. |
| Brand Color Integration | Automatically uses your MyListing brand color for email styling (buttons, links, icons). |
How It Works
The plugin works on a simple monthly cycle:
1. You configure the schedule in the MyListing Notifications settings — pick a day of the month and a time of day.
2. The plugin runs a daily background check at your chosen time. On the configured day of the month, it sends reports.
3. It finds all users who have at least one published listing and are opted in to reports.
4. Each eligible user receives an HTML email containing their listing performance statistics — views, unique views, device breakdowns, visitor countries, referral sources, platforms, and browsers.
5. Users who no longer want reports can opt out via their profile page or click the unsubscribe link in any email.
Configuring the Schedule
Navigate to Listing Types → Settings → Notifications in the WordPress admin. The plugin adds its own settings panel at the bottom of the existing notifications list.
Step 1: Enable the Notification
Set the dropdown to “Enable Notification”. When disabled, no emails are sent and the background schedule is removed.
Step 2: Choose the Send Date
Select when reports should be sent each month:
| Option | When Reports Are Sent |
|---|---|
| Every 1st of the month | Reports go out on the 1st of each month. |
| Every 15th of the month | Reports go out on the 15th of each month. |
| Every end of the month | Reports go out on the last day of each month (28th, 29th, 30th, or 31st depending on the month). |
Step 3: Choose the Send Time
Select the hour of the day when the background check should run. When the date matches, emails will be sent at approximately this time.
Note: The plugin uses WordPress’s built-in scheduling system (WP-Cron), which relies on site visits to trigger. On low-traffic sites, emails may be delayed slightly. For precise timing, ask your hosting provider about setting up a server-level cron job.
Step 4: Save
Click the “Save Changes” button on the MyListing settings page. The schedule is now active.
Sending a Test Email
Before waiting for the scheduled date, you can preview exactly what listing owners will receive:
1. Enter an email address in the “Test Email” field in the notification settings.
2. Click “Send Test Email”.
3. The plugin finds the first user on your site who has published listings, generates a full report using their real statistics, and sends it to the address you specified.
You’ll see a success or failure message confirming the result.
Tip: The test email uses real data from an actual listing owner, so you’ll see a realistic preview of the report format and content.
What’s in the Report Email
Each report email includes a personalized greeting, a “View Dashboard” button linking to the user’s account page, and eight statistics widgets:
| Widget | What It Shows |
|---|---|
| Views | Total views, views this month, and views today. |
| Unique Views | Unique visitor counts (total, this month, today). |
| Tracks by Type | Views broken down by listing type. |
| Devices | Desktop, mobile, and tablet visitor split. |
| Countries | Top visitor countries. |
| Referrers | Top traffic referral sources. |
| Platforms | Operating system breakdown (Windows, macOS, iOS, Android, etc.). |
| Browsers | Browser type breakdown (Chrome, Safari, Firefox, etc.). |
The email is styled with your site’s MyListing brand color and includes your site icon and name in the footer. An unsubscribe link appears at the bottom of every email.
User Opt-In and Opt-Out
Users are opted in by default — they receive reports unless they choose to opt out. There are three ways users can manage their preference:
1. WordPress Admin Profile
On the Users → Profile page (or when an admin edits another user’s profile), a “Notifications” section appears with an “Opt-in for listing reports?” checkbox.
2. WooCommerce Account Details
On the My Account → Account Details page on the frontend, the same opt-in checkbox is available so users can manage their preference without needing admin access.
3. Email Unsubscribe Link
Every report email includes an “Unsubscribe” link at the bottom. Clicking it immediately opts the user out and shows a confirmation message explaining that they can re-subscribe by visiting their account details page.
The unsubscribe link uses a unique security token — it only works once and only for the specific user it was generated for.
Who Receives Reports
A user receives a report email when all of the following are true:
1. The email reports notification is enabled in the settings.
2. Today matches the configured send date (1st, 15th, or last day of month).
3. The user has at least one published listing.
4. The user is opted in (either explicitly, or by default if they’ve never changed the setting).
Custom Email Template (Advanced)
If you want to fully customize the email layout, create a file at:
your-theme/templates/emails/codicts-monthly-reports-user-notification.phpThis file will be used instead of the default template. Inside the custom template, the following variables are available:
| Variable | Description |
|---|---|
$this->user | The WP_User object for the email recipient. |
$this->user_id | The recipient’s user ID. |
$this->stats | The user’s statistics data from MyListing. |
$this->sender | The “From” header value. |
$this->subject | The email subject line. |
Customizing the Subject Line or Sender
You can change the email subject or sender without creating a full template override. Add these filters to your theme’s functions.php:
// Custom subject line
add_filter( 'codicts-mylisting-email-reports::subject', function( $subject ) {
return '[My Site] Your Listing Performance Report';
});
// Custom sender
add_filter( 'codicts-mylisting-email-reports::sender', function( $sender ) {
return 'Reports <reports@mysite.com>';
});WooCommerce Email Templates Compatibility
The plugin is compatible with the companion {CODICTS} MyListing | WooCommerce Email Templates plugin. It exposes template tags that can be used within that plugin’s template editor, giving you individual stat widgets you can place and arrange:
| Tag | Description |
|---|---|
views | Views widget |
unique-views | Unique views widget |
tracks-by-type | Tracks by listing type widget |
devices | Devices widget |
countries | Countries widget |
referrers | Referrers widget |
platforms | Platforms widget |
browsers | Browsers widget |
unsubscribe-link | Unsubscribe URL |
Frequently Asked Questions
Are users opted in by default?
Yes. Users who have never interacted with the opt-in setting are treated as opted in. They must explicitly opt out via their profile page, WooCommerce account page, or the unsubscribe link in an email.
How often are reports actually sent?
Once per month, on the day you configure (1st, 15th, or last day of the month). The background check runs daily but only sends emails when the date matches.
Does the test email use real data?
Yes. The test email uses the real statistics of the first user found with published listings. It’s a complete report sent to whatever address you specify.
What statistics are included?
Views, unique views, tracks by listing type, device breakdown, country distribution, referral sources, operating system platforms, and browser types — all sourced from MyListing’s built-in stats engine.
Can I send reports more frequently than monthly?
The plugin is designed for monthly reports. The three schedule options are the 1st, 15th, or last day of each month.
What email delivery method is used?
The plugin uses WordPress’s standard wp_mail() function. For reliable delivery — especially when sending to many listing owners — it’s recommended to use an SMTP plugin such as WP Mail SMTP or FluentSMTP.
Does the plugin affect site performance?
The plugin has minimal impact on regular page loads. The background check runs once daily and only performs work on the configured send date. Admin scripts are only loaded on the MyListing settings page.
Can I customize the email template?
Yes. Create a template file at your-theme/templates/emails/codicts-monthly-reports-user-notification.php to fully customize the email layout. You can also customize just the subject line or sender using PHP filters (see the Custom Email Template section above).
Is the plugin translatable?
Yes. A .pot translation template is included in the /languages/ directory. All button labels, email content, and notification strings are translatable using Loco Translate or any standard WordPress translation tool.
Troubleshooting
Emails Not Being Sent
| Cause | Solution |
|---|---|
| Notification not enabled | Navigate to Listing Types → Settings → Notifications and ensure the email reports notification is set to “Enable Notification”. |
| Wrong date | Emails are only sent on the configured day (1st, 15th, or last day of the month). Use the “Send Test Email” feature to verify your setup works. |
| WP-Cron not running | WordPress’s scheduling system relies on site visits. On low-traffic sites, the schedule may be delayed. Ask your hosting provider about setting up a server-level cron job to trigger wp-cron.php regularly. |
| User not opted in | Verify the user hasn’t opted out. Check their profile page for the opt-in checkbox, or look for the _cmler_optin user meta in the database. |
| No published listings | Users must have at least one published listing to receive reports. |
| Server mail issues | Ensure your server can send emails. Consider using an SMTP plugin (WP Mail SMTP, FluentSMTP) for reliable delivery. |
“MyListing Theme Not Detected” Error
The MyListing theme must be installed and active. Go to Appearance → Themes to verify. The plugin’s settings and functionality do not load without MyListing.
Email Icons or Styling Not Displaying Correctly
| Cause | Solution |
|---|---|
| Image files not accessible | Ensure the plugin’s assets/images/ directory is publicly accessible via HTTP. Some security plugins may block access to plugin asset files. |
| Brand color not applied | The plugin uses your MyListing brand color setting. Verify it’s configured in Theme Options → General. |
| Email client limitations | Different email clients render HTML differently. The template is optimized for Gmail compatibility. Some elements may display differently in Outlook or other clients. |
Unsubscribe Link Not Working
| Cause | Solution |
|---|---|
| Caching plugin interference | Page caching plugins may cache the unsubscribe response. Add the unsubscribe URL pattern to your cache exclusion rules. |
| Token already used | Unsubscribe tokens are single-use. If the user already clicked the link, the token has been consumed. The user is already unsubscribed. |
| Permalink issues | Ensure your site has a permalink structure configured (not “Plain” in Settings → Permalinks). |
Settings Panel Not Appearing
| Cause | Solution |
|---|---|
| MyListing not active | The settings panel is injected into MyListing’s Notifications page. MyListing must be active. |
| JavaScript error | The settings panel is rendered via JavaScript. Check the browser console for errors on the Listing Types → Settings page. |
| Plugin not activated | Verify the plugin is active in Plugins → Installed Plugins. |
For further support, visit codicts.com or contact us at support@codicts.com.