Skip to content

Latest commit

 

History

History
executable file
·
408 lines (292 loc) · 15.2 KB

readme.md

File metadata and controls

executable file
·
408 lines (292 loc) · 15.2 KB
Raw

Mailgun for WordPress

Contributors: mailgun, sivel, lookahead.io, m35dev, alanfuller Tags: mailgun, smtp, http, api, mail, email Tested up to: 6.7 Stable tag: 2.1.3 Requires PHP: 7.4 License: GPLv2 or later

Easily send email from your WordPress site through Mailgun using the HTTP API or SMTP.

Description

Mailgun is the email automation engine trusted by over 10,000 website and application developers for sending, receiving and tracking emails. By taking advantage of Mailgun's powerful email APIs, developers can spend more time building awesome websites and less time fighting with email servers. Mailgun supports all of the most popular languages including PHP, Ruby, Python, C# and Java.

One particularly useful feature of this plugin is that it provides you with a way to send email when the server you are on does not support SMTP or where outbound SMTP is restricted since the plug-in uses the Mailgun HTTP API for sending email by default. All you need to use the plugin is a Mailgun account. Mailgun has a free account that lets you send up to 200 emails per day, which is great for testing. Paid subscriptions are available for increased limits.

The latest version of this plugin now supports regions. Select either U.S./North America or Europe to choose the API endpoint from which you will send email.

The current version of this plugin only handles sending emails, tracking and tagging and list subscription.

Installation

  1. Upload the mailgun folder to the /wp-content/plugins/ directory or install directly through the plugin installer
  2. Activate the plugin through the 'Plugins' menu in WordPress or by using the link provided by the plugin installer
  3. Visit the settings page in the Admin at Settings -> Mailgun and configure the plugin with your account details
  4. Click the Test Configuration button to verify that your settings are correct.
  5. Click View Available Lists to review shortcode settings for lists in your Mailgun account that you may wish to help users subscribe to

== Frequently Asked Questions ==

  • Testing the configuration fails when using the HTTP API

Your web server may not allow outbound HTTP connections. Set Use HTTP API to "No", and fill out the configuration options to SMTP and test again.

  • Testing the configuration fails when using SMTP

Your web server may not allow outbound SMTP connections on port 465 for secure connections or 587 for unsecured connections. Try changing Use Secure SMTP to "No" or "Yes" depending on your current configuration and testing again. If both fail, try setting Use HTTP API to "Yes" and testing again.

If you have to use SMTP and something is still going horribly wrong, enable debug mode in WordPress and also add the MG_DEBUG_SMTP constant to your wp-config.php, like so:

define( 'MG_DEBUG_SMTP', true );

  • Can this be configured globally for WordPress Multisite?

Yes, using the following constants that can be placed in wp-config.php:

Important note

Constant MAILGUN_USEAPI IS REQUIRED

MAILGUN_REGION       Type: string   Choices: 'us' or 'eu'
     ex. define('MAILGUN_REGION', 'us');
MAILGUN_USEAPI       Type: boolean  Choices: '0' or '1' (0 = false/no)
MAILGUN_APIKEY       Type: string
MAILGUN_DOMAIN       Type: string
MAILGUN_USERNAME     Type: string
MAILGUN_PASSWORD     Type: string
MAILGUN_SECURE       Type: boolean  Choices: '0' or '1' (0 = false/no)
MAILGUN_SECTYPE      Type: string   Choices: 'ssl' or 'tls'
MAILGUN_FROM_NAME    Type: string
MAILGUN_FROM_ADDRESS Type: string
MAILGUN_TRACK_CLICKS Type: string Choices: 'yes' or 'no'
MAILGUN_TRACK_OPENS  Type: string Choices: 'yes' or 'no'
MAILGUN_REPLY_TO_ADDRESS Type: string
  • What hooks are available for use with other plugins?

mg_use_recipient_vars_syntax Mutates messages to use recipient variables syntax - see https://documentation.mailgun.com/user_manual.html#batch-sending for more info.

Should accept a list of To addresses.

Should only return true or false.

mg_mutate_message_body Allows an external plugin to mutate the message body before sending.

Should accept an array, $body.

Should return a new array to replace $body.

mg_mutate_attachments Allows an external plugin to mutate the attachments on the message before sending.

Should accept an array, $attachments.

Should return a new array to replace $attachments.

  • What hooks are available for use with other plugins?

mg_use_recipient_vars_syntax Mutates messages to use recipient variables syntax - see https://documentation.mailgun.com/en/latest/user_manual.html#batch-sending for more info.

Should accept a list of To addresses.

Should only return true or false.

mg_mutate_message_body Allows an external plugin to mutate the message body before sending.

Should accept an array, $body.

Should return a new array to replace $body.

mg_mutate_attachments Allows an external plugin to mutate the attachments on the message before sending.

Should accept an array, $attachments.

Should return a new array to replace $attachments.

== Screenshots ==

  1. Configuration options for using the Mailgun HTTP API
  2. Configuration options for using the Mailgun SMTP servers
  3. Administration option to View Available Lists for subscription
  4. Setting up a Subscription Widget
  5. Using a Subscription Code
  6. Subscription Form Seen By Site Visitors

== Changelog ==

= 2.1.3 (2024-11-27): =

  • Use password type for API Key field for hide it. Fix warning related co compact() method

= 2.1.2 (2024-11-17): =

  • Fixed code. Removed line that try to connect not existing file. Fixed versions in the plugin

= 2.1.1 (2024-08-17): =

  • Added fallback to regular mail in case or error during sending email vua API

= 2.1.0 (2024-07-27): =

  • Added ability to suppress Track Clicks when we send Reset Password email (it was an issue with domain url in the email)
  • Added field to setup Reply-to(header) email for the emails.
  • When constants MAILGUN_TRACK_CLICKS, MAILGUN_TRACK_OPENS are used, we disable field on the UI as we do for other fields

= 2.0.1 (2024-07-17): =

  • Updated changelog

= 2.0.0 (2024-07-17): =

  • Updated plugin version and version compatibility
  • Updated tags, located in the svn. Keep only 5 last tags according to Wordpress.org rules

= 1.9.9 (2024-03-13): =

  • Improve admin notices about not fully configured plugin
  • Small code cleaning

= 1.9.8 (2024-02-25): =

  • Improve admin notices about not fully configured plugin
  • Small code cleaning

= 1.9.7 (2024-01-03): =

  • Ensure defaults are always set to remove warnings in PHP 8.1+

= 1.9.6 (2023-09-10): =

  • Added typehints to methods
  • Added code for making plugin WP VIP GO compatible for the From mail
  • Added Toastr for sending nice message instead of using alerts

= 1.9.5 (2023-06-20): =

  • Fix bug with sending emails

= 1.9.4 (2023-06-10): =

  • Fixed bug Fatal error on lists page when another plugin redeclare wp_mail()

= 1.9.3 (2023-04-08): =

  • Fixed Reply-to header. It's not overridden anymore

= 1.9.2 (2023-03-28): =

  • Added action for better dev experience in tracking error mailgun_error_track
  • Added header h:Sender

= 1.9.1 (2023-03-26): =

  • Remove not needed error logging.

  • Fixed bug with Override param for Woocommerce

  • = 1.9 (2023-01-18): =

  • Sanitizing and escaping vars. Possible security issues

= 1.8.10 (2022-12-26): =

  • Fixed bug with not overriding from name for Woocommerce

= 1.8.9 (2022-12-14): =

  • Fixed bug with removed wp_mail filter

= 1.8.8 (2022-12-11): =

  • Fixed bug when $to override in the wp_mail function

= 1.8.7 (2022-11-12): =

  • Fixed bug when field Override "From" Details was not updated

= 1.8.3 (2022-08-30): =

  • Plugin refactoring. Widget fixes for working with Legacy Widget Block. PHP8.0 support check

= 1.8.2 (2022-08-24): =

  • Plugin refactoring. Small fixes

= 1.8.1 (2022-08-19): =

  • backward compatibility with php7.0

= 1.8.0 (2022-08-18): =

  • Plugin refactoring. Using new languages constructions. Extended readme. Update version

= 1.7.9 (2021-05-24): =

  • API Key description

= 1.7.8 (2021-05-13): =

  • Tested WP 5.7.1

= 1.7.7 (2021-03-16): =

  • Updated assets, tested WP 5.7

= 1.7.6 (2021-02-19): =

  • Sync versions across plugin files

= 1.7.3 (2021-02-19): =

  • Update plugin version

= 1.7.2 (2020-10-07): =

  • Test plugin with PHP 7.4.
  • Test plugin up to WordPress 5.5.1.

= 1.7.1 (2019-02-07): =

  • Reinstall settings page for multisites.

= 1.7 (2019-01-21): =

  • Remove settings page for multisites.
  • Simplify admin notifications.
  • Test plugin with PHP 7.2.
  • Test plugin up to WordPress 5.0.3.

= 1.6.1 (2018-10-08): =

  • Restore Settings page form for all install types.

= 1.6 (2018-9-21): =

  • Refactor admin notifications
  • Enable Settings page for all WordPress install types
  • Enable Test Configuration for all WordPress install types
  • Test plugin up to WordPress 4.9.8.

= 1.5.14 (2018-09-11): =

  • Force SSL-secured SMTP connections to use port 465 (SMTPS) to connect, 587 for plain and TLS
  • Support region endpoint switching for SMTP

= 1.5.13.1 (2018-08-15): =

  • Fix line breaks in Test Configuration email

= 1.5.13 (2018-08-14): =

  • Default to US region if no region is configured in settings
  • Add admin notification about region configuration
  • Log an error message when an email is sent with no explicit region configured

= 1.5.12.3 (2018-08-09): =

  • Fix Region select menu default when wp-config.php variable is set
  • Fix front end email input validation

= 1.5.12.2 (2018-08-09): =

  • Fix plugin not saving after update

= 1.5.12.1 (2018-08-06): =

  • Fix for backwards compatibility

= 1.5.12 (2018-08-02): =

  • Add EU endpoint for Mailgun HTTP API
  • Fix broken logo image on Lists page
  • Test plugin up to Wordpress 4.9.7

= 1.5.11 (2018-05-30): =

  • Fix an issue with authentication failing for newer API keys
  • Test plugin up to Wordpress 4.9.6

= 1.5.10 (2017-11-22): =

  • Fix back to settings link on lists page (#65)
  • Fix a bug causing text/html emails to send as both text/plain and text/html parts

= 1.5.9 (2017-09-13): =

  • Add a configuration option to allow setting security type for SMTP connection (SSL / TLS)

= 1.5.8.5 (2017-09-05): =

  • Change default click tracking setting to htmlonly (#58)
  • Change PHPMailer set-up stanza to use TLS

= 1.5.8.4 (2017-06-28): =

= 1.5.8.3 (2017-06-13): =

= 1.5.8.2 (2017-02-27): =

  • Fix a bug causing empty tags to be sent with messages (#51)
  • Add mg_mutate_message_body hook to allow other plugins to modify the message body before send
  • Add mg_mutate_attachments hook to allow other plugins to modify the message attachments before send
  • Fix a bug causing the AJAX test to fail incorrectly.

= 1.5.8.2 (2017-02-27): =

  • Fix a bug causing empty tags to be sent with messages (#51)
  • Add mg_mutate_message_body hook to allow other plugins to modify the message body before send
  • Add mg_mutate_attachments hook to allow other plugins to modify the message attachments before send
  • Fix a bug causing the AJAX test to fail incorrectly.

= 1.5.8.1 (2017-02-06): =

  • Fix "Undefined property: MailgunAdmin::$hook_suffix" (#48)
  • Fix "Undefined variable: from_name on every email process" (API and SMTP) (#49)
  • Admin code now loads only on admin user access

= 1.5.8 (2017-01-23): =

  • Rewrite a large chunk of old SMTP code
  • Fix a bug with SMTP + "override from" that was introduced in 1.5.7
  • SMTP debug logging is now controlled by MG_DEBUG_SMTP constant

= 1.5.7.1 (2017-01-18): =

  • Fix an odd Undefined property: MailgunAdmin::$defaults when saving config
  • Fix strict mode notice for using $mailgun['override-from'] without checking isset

= 1.5.7 (2017-01-04): =

= 1.5.6 (2016-12-30): =

  • Fix a very subtle bug causing fatal errors with older PHP versions < 5.5
  • Respect wp_mail_content_type (#37 - @FPCSJames)

= 1.5.5 (2016-12-27): =

  • Restructure the admin_notices code
  • Restructure the "From Name" / "From Address" code
  • Add option to override "From Name" / "From Address" setting set by other plugins
  • Fix a bug causing default "From Name" / "From Address" to be always applied in some cases
  • Moved plugin header up in entrypoint file (https://wordpress.org/support/topic/plugin-activation-due-to-header/#post-8598062)
  • Fixed a bug causing "Override From" to be set to "yes" after upgrades

= 1.5.4 (2016-12-23): =

  • Changed some missed bracketed array usages to array() syntax
  • Fix wp_mail_from / wp_mail_from_name not working on old PHP / WP versions
  • Add a wrapper for using mime_content_type / finfo_file

= 1.5.3 (2016-12-22): =

  • Changed all bracketed array usages to array() syntax for older PHP support
  • Redesigned Content-Type processing code to not make such large assumptions
  • Mailgun logo is now loaded over HTTPS
  • Fixed undefined variable issue with from email / from name code

= 1.5.2 (2016-12-22): =

  • Added option fields for setting a From name and address

= 1.5.1 (2016-12-21): =

  • Fixed an issue causing plugin upgrades from <1.5 -> >=1.5 to deactivate

= 1.5 (2016-12-19): =

  • Added Catalan language support (@DavidGarciaCat)
  • Added Spanish language support (@DavidGarciaCat)
  • Added German language support (@lsinger)
  • Fixed incorrect SMTP hostname
  • Applied PSR standards across codebase
  • Applied open tracking bugfix
  • Applied tags bugfix
  • Applied Mailgun Lists admin panel bugfix
  • Fixed click tracking dropdown
  • Fixed click tracking and open tracking
  • Now try to process all sent mails as HTML, see L201 wp-mail.php for details
  • Mailgun logo now loads on both admin pages ;)
  • Now using the Mailgun API v3 endpoint!
  • Configuration test will now present either an error from the API or the HTTP response code + message

= 1.4.1 (2015-12-01): =

  • Clarify compatibility with WordPress 4.3

= 1.4 (2015-11-15): =

  • Added shortcode and widget support for list subscription

= 1.3.1 (2014-11-19): =

  • Switched to Semantic Versioning
  • Fixed issue with campaigns and tags

= 1.3 (2014-08-25): =

  • Added check to ignore empty attachments

= 1.2 (2014-08-19): =

  • Fixed errors related to undefined variable. #3

= 1.1 (2013-12-09): =

  • Attachments are now handled properly.
  • Added ability to customize tags and campaigns.
  • Added ability to toggle URL and open tracking.

= 1.0 (2012-11-27): =

  • Re-release to update versioning to start at 1.0 instead of 0.1

= 0.1 (2012-11-21): =

  • Initial Release