WireMailMailgun by macrura

Mailgun for ProcessWire

WireMailMailgun

Mailgun module for ProcessWire

Configuration


Set settings in module configuration page.

Usage


Usage is similar to the basic WireMail implementation, although a few extra options are available.

Basic usage is as such:

  1. Initialize $mail = wireMail(); Note this also works: $m = $mail->new();
  2. Set options $mail->to('Someone <someone@example.com>); ...
  3. Send $mail->send();

Methods


$WireMailMailgun->to( string|array|null $recipients )

$WireMailMailgun->cc( string|array|null $recipients )

$WireMailMailgun->bcc( string|array|null $recipients )

$WireMailMailgun->setApiKey( string $apiKey )

$WireMailMailgun->setDomainName( string $domainName )

$WireMailMailgun->setTestMode( bool $bool )

$WireMailMailgun->setBatchMode( bool $bool )

When batch mode is set to true (default mode of operation), each recipient passed to the to() method will not be able to see who else is receiving the sent email. This will send one email per "To:" recipient.

Set to false to disable this behavior. This will send one email with multiple "To:" recipients.

Note that in both cases all CCs and BCCs will be delivered for each email sent. This means that if batch mode is on, that you have 10 "To:" recipients and 3 CCs, 40 emails will be sent in total.

Important: Mailgun has a maximum hard limit of recipients allowed per batch of 1,000. Read more about batch sending.

$WireMailMailgun->setToRecipientsVariables( array $array )

Add custom variables for batch mode. ex.:

$WireMailMailgun->setToRecipientsVariables(array(
	'someone@example.com' => array(
		'username' => 'Someone',
		'token' => '123456',
	), ...
));

$WireMailMailgun->setClickTracking( bool $bool )

$WireMailMailgun->setOpenTracking( bool $bool )

$WireMailMailgun->addAttachment( string $filepath )

Usage is the same as realpath() internally for convenience.

$WireMailMailgun->addTag( string $tag )

Add a tag to the email. Note that there is a maximum number of 3 tags allowed per email.

Also, the tag string should be ASCII only and its length should be 128 characters or less. If any of those conditions are not met, the module will convert any non-ASCII characters to ASCII and trim the string length to 128.

$WireMailMailgun->validateEmail( string $email )

Validates a single address using Mailgun's address validation service.

For more information on what this method returns, see Mailgun's documentation.

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Twitter updates

  • New post: Multi-language field translation export/import — In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire… More
    5 August 2022
  • Weekly update, July 29: Continuing upgrades to ProcessWire’s comments system and FormBuilder, along with a working example—More
    29 July 2022
  • Weekly update for July 22– Looking back at what web development was like in the year 2000. Plus some more discussion on the path from CKEditor 4 to CkEditor 5 in ProcessWire: More
    22 July 2022

Latest news

  • ProcessWire Weekly #430
    In the 430th issue of ProcessWire Weekly we're going to check out some brand new third party modules, a new site of the week, and more. Read on!
    Weekly.pw / 7 August 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani