Documentation

Explore the guides & API reference

Installation & Setup

This guide will walk you through installing and configuring Mailtric on your WordPress site, so you can start tracking your Mail Metrics.

System Requirements

Before installing Mailtric, ensure your WordPress site meets the following requirements:

Minimum Requirements

  • WordPress 5.0 or higher
  • PHP 7.4 or higher
  • GD Library or ImageMagick
  • Memory limit of at least 256MB
  • MySQL 5.6 or higher

Installation Methods

Method 1: WordPress Admin Dashboard (Recommended)

  1. Access your WordPress admin dashboard
  2. Navigate to Plugins → Add New
  3. Search for "Mailtric"
  4. Click "Install Now"
  5. Activate the plugin

Installation Complete!

Once activated, you'll see Mailtric in your admin sidebar. You can now proceed to the initial configuration.

Method 2: Manual Upload

  1. Download the plugin from WordPress.org or GitHub
  2. Upload the plugin files to /wp-content/plugins/opengraphpress/
  3. Activate the plugin through the WordPress admin dashboard
  1. Go to Plugins → Add New
  2. Click Upload Plugin
  3. Choose the downloaded ZIP file
  4. Click Install Now
  5. Activate the plugin

Initial Configuration

After installation, you'll need to configure the basic settings:

1. Access Plugin Settings

Navigate to Mailtric → Settings in your WordPress admin sidebar.

2. Basic Configuration

Important

Complete these basic settings before generating your first images to ensure optimal results.

General Settings

  • Default Template: Choose your preferred default template
  • Image Format: Select JPEG or PNG (JPEG recommended for smaller file sizes)
  • Image Quality: Set between 70-100 (90 recommended)
  • Image Dimensions: Default is 1200x630px (Facebook recommended)

Brand Settings

  • Logo Upload: Upload your brand logo (PNG format recommended)
  • Primary Color: Set your brand's primary color
  • Secondary Color: Set your brand's secondary color
  • Font Selection: Choose from available fonts or upload custom fonts

3. Template Configuration

Configure your default template settings:

// Example configuration
$config = [
    'template' => 'modern',
    'logo_position' => 'top-left',
    'title_font_size' => 48,
    'background_color' => '#ffffff',
    'text_color' => '#333333'
];

4. Content Type Settings

Enable Mailtric for specific content types:

  • Posts: ✅ Enabled by default
  • Pages: Configure as needed
  • Custom Post Types: Select which types to include
  • Categories/Tags: Enable for archive pages

Verification

To verify your installation is working correctly:

  1. Create or edit a post
  2. Publish the post
  3. Check the post's meta data for Open Graph tags
  4. Test on social media or use a validator tool

Testing Tools

Troubleshooting Installation Issues

Common Issues

Plugin Won't Activate

Possible causes:

  • PHP version too low
  • Missing required extensions
  • Plugin conflicts
  • Insufficient permissions

Solutions:

  1. Check PHP version and update if needed
  2. Install GD Library or ImageMagick
  3. Deactivate other plugins temporarily
  4. Check file permissions (755 for directories, 644 for files)

Memory Issues

If you encounter memory limit errors:

// Add to wp-config.php
ini_set('memory_limit', '512M');

// Or add to .htaccess
php_value memory_limit 512M

File Permission Issues

Set correct permissions:

# For directories
chmod 755 wp-content/plugins/opengraphpress/

# For files
chmod 644 wp-content/plugins/opengraphpress/*

Next Steps

After successful installation and configuration:

  1. Create Your First Image - Learn the basics
  2. Customize Templates - Make it your own
  3. Configure Advanced Settings - Fine-tune the plugin

Need Help?

If you encounter any issues during installation:


Installation Complete!

Congratulations! Mailtric is now installed and ready to provide email insights.

Need Help?

Can't find what you're looking for? We're here to help you get the most out of Mailtric.