bachir/materio-base-legacy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

added mailgun module

Browse Source
This commit is contained in:
Bachir Soussi Chiadmi
2016-07-19 17:52:15 +02:00
parent c64551f50c
commit deae7e0b59
42 changed files with 3659 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

339
sites/all/modules/contrib/mail/mailgun/LICENSE.txt Normal file
View File

@@ -0,0 +1,339 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

221
sites/all/modules/contrib/mail/mailgun/mailgun.admin.inc Normal file
View File

@@ -0,0 +1,221 @@
<?php
/**
* @file
* Administration page callbacks for Mailgun.
*/
/**
* Menu callback: displays the Mailgun module settings page.
*
* @param array $form
* Form render array.
* @param array $form_state
* Array containing form state values.
*
* @return array
* An array containing form items to place on the module settings page.
*/
function mailgun_admin_settings($form, &$form_state) {
$library = libraries_detect('mailgun');
if (!$library['installed']) {
drupal_set_message(t('The Mailgun PHP library is not installed. Please see <a href="@url">documentation</a> for more information.', array('@url' => url('https://www.drupal.org/node/2547591'))), 'error');
}
$key = variable_get('mailgun_api_key', '');
$form['mailgun_api_key'] = array(
'#title' => t('Mailgun API key'),
'#type' => 'textfield',
'#description' => t('Get your Secret API key from the <a href="@url">Mailgun dashboard</a>.', array('@url' => url('https://mailgun.com/app/dashboard'))),
'#default_value' => $key,
'#required' => TRUE,
);
$client = FALSE;
if (!empty($key)) {
try {
$client = mailgun_get_client($key);
} catch (Exception $e) {
watchdog('mailgun', 'An exception occurred. @code: @message', array('@code' => $e->getCode(), '@message' => $e->getMessage()), WATCHDOG_WARNING, 'admin/config/system/mailgun');
drupal_set_message(t('Mailgun: %message', array('%message' => $e->getMessage())), 'error');
}
}
// Display settings only when a valid API key is present and client is active
if ($client) {
$domain_options = array(
'_sender' => t('Get domain from sender address'),
);
$domains = array();
$result = $client->get('domains');
if ($result && $result->http_response_code == 200) {
foreach ($result->http_response_body->items as $domain) {
$domains[$domain->name] = $domain;
$domain_options[$domain->name] = $domain->name;
}
}
$form['mailgun_domain'] = array(
'#title' => t('Domain'),
'#type' => 'select',
'#options' => $domain_options,
'#description' => t('Mails will be sent using this domain'),
'#default_value' => variable_get('mailgun_domain', '_sender'),
);
$form['mailgun_test'] = array(
'#title' => t('Test mode'),
'#type' => 'checkbox',
'#default_value' => variable_get('mailgun_test', FALSE),
'#description' => t('Enables sending in test mode'),
);
$form['mailgun_queue'] = array(
'#title' => t('Queue mails'),
'#type' => 'checkbox',
'#description' => t('Mails will be queued and sent during cron runs. Useful for sending a large number of emails.'),
'#default_value' => variable_get('mailgun_queue', FALSE),
);
$form['mailgun_log'] = array(
'#title' => t('Log mails'),
'#type' => 'checkbox',
'#description' => t('Log mails sent through Mailgun. Should not be enabled on production sites. Messages fail to send will be logged regardless of this setting.'),
'#default_value' => variable_get('mailgun_log', FALSE),
);
$formats = array('_none' => t('- None -'));
foreach (filter_formats() as $format) {
if ($format->format == 'php_code') {
continue;
}
$formats[$format->format] = t($format->name);
}
$form['mailgun_format'] = array(
'#title' => t('Text format'),
'#type' => 'select',
'#description' => t('Specify an additional text format to filter the message through before sending the email.'),
'#options' => $formats,
'#default_value' => variable_get('mailgun_format', '_none'),
);
$form['defaults'] = array(
'#type' => 'fieldset',
'#title' => t('Default settings'),
'#description' => t('These default settings apply to messages sent using Mailgun and may be overriden on a per-message basis.'),
'#collapsible' => FALSE,
'#collapsed' => FALSE,
);
$form['defaults']['mailgun_tracking'] = array(
'#title' => t('Enable tracking'),
'#type' => 'select',
'#options' => array('default' => t('Use default setting'), 'enabled' => t('Enabled'), 'disabled' => t('Disabled')),
'#description' => t('Whether to enable event tracking by default or not. See <a href="@url">Tracking Messages</a> for details.', array('@url' => url('https://documentation.mailgun.com/user_manual.html#tracking-messages'))),
'#default_value' => variable_get('mailgun_tracking', 'default'),
);
$form['defaults']['mailgun_tracking_clicks'] = array(
'#title' => t('Enable click tracking'),
'#type' => 'select',
'#options' => array('default' => t('Use default setting'), 'enabled' => t('Enabled'), 'disabled' => t('Disabled')),
'#description' => t('Whether to enable click tracking by default or not.'),
'#default_value' => variable_get('mailgun_tracking_clicks', 'default'),
);
$form['defaults']['mailgun_tracking_opens'] = array(
'#title' => t('Enable open tracking'),
'#type' => 'select',
'#options' => array('default' => t('Use default setting'), 'enabled' => t('Enabled'), 'disabled' => t('Disabled')),
'#description' => t('Whether to enable open tracking by default or not.'),
'#default_value' => variable_get('mailgun_tracking_opens', 'default'),
);
}
$form = system_settings_form($form);
$form['#validate'][] = 'mailgun_admin_settings_validate';
return $form;
}
/**
* Form validation handler for mailgun_admin_settings().
*
* Perform additional validation to ensure the API key entered is valid.
*/
function mailgun_admin_settings_validate($form, &$form_state) {
if ($form['mailgun_api_key']['#default_value'] != $form_state['values']['mailgun_api_key']) {
// The API key has changed. Perform validation.
$form_state['values']['mailgun_api_key'] = trim($form_state['values']['mailgun_api_key']);
$client = mailgun_get_client($form_state['values']['mailgun_api_key']);
try {
$result = $client->get('domains');
drupal_set_message(t('Your API key has been successfully validated.'));
} catch (Exception $e) {
form_set_error('mailgun_api_key', t('An exception occurred. @code: @message', array('@code' => $e->getCode(), '@message' => $e->getMessage())));
}
}
}
/**
* Form builder. Display a form for sending a test e-mail.
*/
function mailgun_test_form($form, &$form_state) {
drupal_set_title(t('Send test mail'));
$form['to'] = array(
'#type' => 'textfield',
'#title' => t('To'),
'#default_value' => variable_get('site_mail', ''),
'#description' => t('Type in an address to have the test email sent there.'),
'#required' => TRUE,
);
$message = "Howdy!\n\nIf this e-mail is displayed correctly and delivered sound and safe, congrats! You have successfully configured Mailgun.";
$message .= ' Visit the <a href="@project">project page</a> to contribute or read <a href="@documentation">documentation</a> to learn more.';
$message = t($message, array('@project' => url('https://www.drupal.org/project/mailgun'), '@documentation' => url('https://www.drupal.org/node/2547591')));
$form['message'] = array(
'#type' => 'textarea',
'#title' => t('Message'),
'#default_value' => $message,
'#required' => TRUE,
);
$form['attachment'] = array(
'#title' => t('Include attachment'),
'#type' => 'checkbox',
'#description' => t('If checked, the Drupal icon will be included as an attachment with the test e-mail.'),
'#default_value' => TRUE,
);
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('Send'),
);
$form['cancel'] = array(
'#type' => 'link',
'#href' => 'admin/config/system/mailgun',
'#title' => t('Cancel'),
);
return $form;
}
/**
* Form submission handler for mailgun_test_form().
* Send the test e-mail.
*/
function mailgun_test_form_submit($form, &$form_state) {
$to = $form_state['values']['to'];
$params = array(
'message' => $form_state['values']['message'],
'attachment' => $form_state['values']['attachment'],
);
$site_name = variable_get('site_name', '');
$default_from = variable_get('site_mail', ini_get('sendmail_from'));
$from = (!empty($site_name)) ? $site_name . ' <' . $default_from . '>' : $default_from;
$result = drupal_mail('mailgun', 'test', $to, $GLOBALS['language'], $params, $from);
drupal_set_message(t('Test email sent from %from to %to. If you have the "Log mails" setting enabled, check the <a href="@url">database log</a> for details.', array('%from' => $result['from'], '%to' => $result['to'], '@url' => url('admin/reports/dblog'))), 'status');
}

16
sites/all/modules/contrib/mail/mailgun/mailgun.info Normal file
View File

@@ -0,0 +1,16 @@
name = Mailgun
description = "Provides integration with Mailgun's email sending API."
core = 7.x
package = Mailgun
dependencies[] = libraries
dependencies[] = mailsystem
files[] = mailgun.mail.inc
; Information added by Drupal.org packaging script on 2016-06-26
version = "7.x-1.6+0-dev"
core = "7.x"
project = "mailgun"
datestamp = "1466914444"

34
sites/all/modules/contrib/mail/mailgun/mailgun.install Normal file
View File

@@ -0,0 +1,34 @@
<?php
/**
* @file
* Install, update and uninstall functions for the Mailgun module.
*/
/**
* Implements hook_uninstall().
*/
function mailgun_uninstall() {
// Delete variables.
$variables = array('mailgun_api_key', 'mailgun_from_action', 'mailgun_from_name', 'mailgun_from_mail', 'mailgun_tracking', 'mailgun_tracking_clicks', 'mailgun_tracking_opens', 'mailgun_queue', 'mailgun_log', 'mailgun_format');
foreach ($variables as $variable) {
variable_del($variable);
}
}
/**
* Implements hook_enable().
*/
function mailgun_enable() {
mailsystem_set(array('mailgun_test' => 'MailgunMailSystem'));
}
/**
* Implements hook_disable().
*/
function mailgun_disable() {
// Tell Mail System to remove Mailgun and restore to defaults.
mailsystem_clear(array('mailgun_test' => 'MailgunMailSystem'));
watchdog('mailgun', 'Mailgun has been disabled.');
}

123
sites/all/modules/contrib/mail/mailgun/mailgun.mail.inc Normal file
View File

@@ -0,0 +1,123 @@
<?php
/**
* @file
* Implements Mailgun as a Drupal MailSystemInterface
*/
/**
* Modify the Drupal mail system to use Mailgun when sending e-mails.
*/
class MailgunMailSystem implements MailSystemInterface {
/**
* Concatenate and wrap the e-mail body for either plain-text or HTML e-mails.
*
* @param array $message
* A message array, as described in hook_mail_alter().
*
* @return array
* The formatted $message.
*/
public function format(array $message) {
// Join the body array into one string.
if (is_array($message['body'])) {
$message['body'] = implode("\n\n", $message['body']);
}
// If a text format is specified in Mailgun settings, run the message through it.
$format = variable_get('mailgun_format', '_none');
if ($format != '_none') {
$message['body'] = check_markup($message['body'], $format);
}
return $message;
}
/**
* Send the e-mail message.
*
* @see drupal_mail()
* @see https://documentation.mailgun.com/api-sending.html#sending
*
* @param array $message
* A message array, as described in hook_mail_alter(). $message['params'] may contain additional parameters. See mailgun_send().
*
* @return bool
* TRUE if the mail was successfully accepted or queued, FALSE otherwise.
*/
public function mail(array $message) {
// Build the Mailgun message array.
$mailgun_message = array(
'from' => $message['from'],
'to' => $message['to'],
'subject' => $message['subject'],
'text' => check_plain($message['body']),
'html' => $message['body'],
);
// Add CC, BCC and Reply-To fields if not empty.
$headers = array_change_key_case($message['headers']);
if (!empty($headers['cc'])) {
$mailgun_message['cc'] = $headers['cc'];
}
if (!empty($headers['bcc'])) {
$mailgun_message['bcc'] = $headers['bcc'];
}
if (!empty($headers['reply-to'])) {
$mailgun_message['h:Reply-To'] = $headers['reply-to'];
}
$params = array();
// Populate default settings.
if ($variable = variable_get('mailgun_tracking', 'default') != 'default') {
$params['o:tracking'] = $variable;
}
if ($variable = variable_get('mailgun_tracking_clicks', 'default') != 'default') {
$params['o:tracking-clicks'] = $variable;
}
if ($variable = variable_get('mailgun_tracking_opens', 'default') != 'default') {
$params['o:tracking-opens'] = $variable;
}
// For a full list of allowed parameters, see: https://documentation.mailgun.com/api-sending.html#sending.
$allowed_params = array('o:tag', 'o:campaign', 'o:deliverytime', 'o:dkim', 'o:testmode', 'o:tracking', 'o:tracking-clicks', 'o:tracking-opens');
foreach ($message['params'] as $key => $value) {
// Check if it's one of the known parameters.
$allowed = (in_array($key, $allowed_params)) ? TRUE : FALSE;
// If more options become available but are not yet supported by the module, uncomment the following line.
//$allowed = (substr($key, 0, 2) == 'o:') ? TRUE : FALSE;
if ($allowed) {
$params[$key] = $value;
}
// Check for custom MIME headers or custom JSON data.
if (substr($key, 0, 2) == 'h:' || substr($key, 0, 2) == 'v:') {
$params[$key] = $value;
}
}
// Make sure the files provided in the attachments array exist.
if (!empty($message['params']['attachments'])) {
$params['attachments'] = array();
foreach ($message['params']['attachments'] as $attachment) {
if (file_exists($attachment)) {
$params['attachments'][] = $attachment;
}
}
}
$mailgun_message['params'] = $params;
// Queue the message if the setting is enabled.
if (variable_get('mailgun_queue', FALSE)) {
$queue = DrupalQueue::get('mailgun_queue', TRUE);
$queue->createItem($mailgun_message);
return TRUE;
}
return mailgun_send($mailgun_message);
}
}

261
sites/all/modules/contrib/mail/mailgun/mailgun.module Normal file
View File

@@ -0,0 +1,261 @@
<?php
/**
* @file
* Provides integration with Mailgun's email sending API.
*/
/**
* Implements hook_menu().
*/
function mailgun_menu() {
$items = array();
$items['admin/config/system/mailgun'] = array(
'title' => 'Mailgun',
'description' => 'Configure Mailgun settings.',
'page callback' => 'drupal_get_form',
'page arguments' => array('mailgun_admin_settings'),
'access arguments' => array('administer mailgun'),
'file' => 'mailgun.admin.inc',
);
$items['admin/config/system/mailgun/settings'] = array(
'title' => 'Settings',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => 0,
);
$items['admin/config/system/mailgun/test'] = array(
'title' => 'Send test email',
'page callback' => 'drupal_get_form',
'page arguments' => array('mailgun_test_form'),
'access arguments' => array('administer mailgun'),
'description' => 'Send a test e-mail using the Mailgun API.',
'file' => 'mailgun.admin.inc',
'type' => MENU_LOCAL_TASK,
'weight' => 1,
);
return $items;
}
/**
* Implements hook_permission().
*/
function mailgun_permission() {
return array(
'administer mailgun' => array(
'title' => t('Administer Mailgun'),
'description' => t('Perform administration tasks for the Mailgun e-mail sending service.'),
"restrict access" => TRUE,
),
);
}
/**
* Implements hook_help().
*/
function mailgun_help($path, $arg) {
switch ($path) {
case 'admin/config/system/mailgun':
return '<p>' . t('See <a href="@url">documentation</a> for instructions on installing and configuring Mailgun.', array('@url' => url('https://www.drupal.org/node/2547591'))) . '</p>';
break;
case 'admin/config/system/mailgun/test':
return '<p>' . t('Use this form to send a test e-mail to ensure you have correctly configured Mailgun.') . '</p>';
break;
}
}
/**
* Implements hook_cron_queue_info().
*/
function mailgun_cron_queue_info() {
$queues = array();
$queues['mailgun_queue'] = array(
'worker callback' => 'mailgun_send',
'time' => 60,
);
return $queues;
}
/**
* Implements hook_mail().
*/
function mailgun_mail($key, &$message, $params) {
switch ($key) {
case 'test':
$message['subject'] = t('Mailgun test email');
$message['body'] = $params['message'];
if ($params['attachment']) {
$message['params']['attachments'] = array(drupal_realpath('misc/druplicon.png'));
}
break;
}
}
/**
* Implements hook_libraries_info().
*/
function mailgun_libraries_info() {
$libraries['mailgun'] = array(
'name' => 'Mailgun PHP library',
'vendor url' => 'https://documentation.mailgun.com/wrappers.html#php',
'download url' => 'https://github.com/mailgun/mailgun-php/archive/v1.7.2.zip',
'path' => 'vendor',
'version arguments' => array(
'file' => 'src/Mailgun/Constants/Constants.php',
// const SDK_VERSION = "1.7";
'pattern' => '/const SDK_VERSION = \"((\d+)\.(\d+))\";/',
),
'files' => array(
'php' => array('autoload.php'),
),
);
return $libraries;
}
/**
* Get the Mailgun client to access Mailgun's endpoints.
*
* @param string $key
* The Mailgun API key. Leave empty to use the API key saved in database.
*/
function mailgun_get_client($key = '') {
// Check if the Mailgun PHP library is installed.
$library = libraries_load('mailgun');
if (!$library['installed']) {
watchdog('mailgun', 'Mailgun client initialization failed: Unable to load the Mailgun PHP library.', NULL, WATCHDOG_ERROR);
return FALSE;
}
$key = (empty($key)) ? variable_get('mailgun_api_key', '') : $key;
if (empty($key)) {
watchdog('mailgun', 'Mailgun client initialization failed: Missing API key.', NULL, WATCHDOG_ERROR);
return FALSE;
}
$client = new \Mailgun\Mailgun($key);
return $client;
}
/**
* Send an e-mail using the Mailgun API.
*
* @param array $mailgun_message
* A Mailgun message array. Contains the following keys:
* - from: The e-mail addressthe message will be sent from.
* - to: The e-mail addressthe message will be sent to.
* - subject: The subject of the message.
* - text: The plain-text version of the message. Processed using check_plain().
* - html: The original message content. May contain HTML tags.
* - cc: One or more carbon copy recipients. If multiple, separate with commas.
* - bcc: One or more blind carbon copy recipients. If multiple, separate with commas.
* - o:tag: An array containing the tags to add to the message. See: https://documentation.mailgun.com/user_manual.html#tagging.
* - o:campaign: The campaign ID this message belongs to. See: https://documentation.mailgun.com/user_manual.html#um-campaign-analytics.
* - o:deliverytime: Desired time of delivery. Messages can be scheduled for a maximum of 3 days in the future. See: https://documentation.mailgun.com/api-intro.html#date-format.
* - o:dkim: Boolean indicating whether or not to enable DKIM signatures on per-message basis.
* - o:testmode: Boolean indicating whether or not to enable test mode. See: https://documentation.mailgun.com/user_manual.html#manual-testmode.
* - o:tracking: Boolean indicating whether or not to toggle tracking on a per-message basis. See: https://documentation.mailgun.com/user_manual.html#tracking-messages.
* - o:tracking-clicks: Boolean or string "htmlonly" indicating whether or not to toggle clicks tracking on a per-message basis. Has higher priority than domain-level setting.
* - o:tracking-opens: Boolean indicating whether or not to toggle clicks tracking on a per-message basis. Has higher priority than domain-level setting.
* - h:X-My-Header: h: prefix followed by an arbitrary value allows to append a custom MIME header to the message (X-My-Header in this case). For example, h:Reply-To to specify Reply-To address.
* - v:my-var: v: prefix followed by an arbitrary name allows to attach a custom JSON data to the message. See: https://documentation.mailgun.com/user_manual.html#manual-customdata.
*
* @return bool
* TRUE if the mail was successfully accepted, FALSE otherwise.
*/
function mailgun_send($mailgun_message) {
$client = mailgun_get_client();
if (!$client) {
return FALSE;
}
// Test mode
if (variable_get('mailgun_test', FALSE)) {
$mailgun_message['o:testmode'] = 'yes';
}
// Merge the $mailgun_message array with options.
$mailgun_message += $mailgun_message['params'];
unset($mailgun_message['params']);
if (variable_get('mailgun_domain', '_sender') == '_sender') {
// Extract the domain from the sender's email address. Use regular expression to check since it could be either a plain email address or in the form "Name <example@example.com>".
$tokens = (preg_match('/^\s*(.+?)\s*<\s*([^>]+)\s*>$/', $mailgun_message['from'], $matches) === 1) ? explode('@', $matches[2]) : explode('@', $mailgun_message['from']);
$mail_domain = array_pop($tokens);
// Retrieve a list of available domains first.
$domains = array();
try {
$result = $client->get('domains');
if ($result->http_response_code == 200) {
foreach ($result->http_response_body->items as $item) {
$domains[$item->name] = $item->name;
}
}
else {
watchdog('mailgun', 'Mailgun server returned a %code error. Could not retrieve domain list.', array('%code' => $result->http_response_code), WATCHDOG_ERROR);
}
} catch (Exception $e) {
watchdog('mailgun', 'An exception occurred while retrieving domains. @code: @message', array('@code' => $e->getCode(), '@message' => $e->getMessage()), WATCHDOG_ERROR);
}
if (empty($domains)) {
// No domain available. Although this shouldn't happen, doesn't hurt to check.
return FALSE;
}
// Now, we need to get the working domain. This is generally the domain the From address is on or the root domain of it.
$working_domain = '';
if ($key = array_search($mail_domain, $domains) !== FALSE) {
// Great. Found it.
$working_domain = $mail_domain;
}
else {
// Oops. No match. Perhaps it's a subdomain instead.
foreach ($domains as $domain) {
if (strpos($domain, $mail_domain) !== FALSE) {
// Got it.
$working_domain = $domain;
break;
}
}
}
// There is a chance that the user is attempting to send from an email address that's on a domain not yet added to the Mailgun account.
// In that case, abort sending and report error.
if (empty($working_domain)) {
watchdog('mailgun', 'Unable to locate a working domain for From address %mail. Aborting sending.', array('%mail' => $mailgun_message['from']), WATCHDOG_ERROR);
return FALSE;
}
}
else {
$working_domain = variable_get('mailgun_domain', '');
}
// Attachments
$post_data = array();
if (!empty($mailgun_message['attachments'])) {
// Send message with attachments.
$post_data['attachment'] = $mailgun_message['attachments'];
unset($mailgun_message['attachments']);
}
try {
$result = $client->sendMessage($working_domain, $mailgun_message, $post_data);
// For a list of HTTP response codes, see: https://documentation.mailgun.com/api-intro.html#errors.
if ($result->http_response_code == 200) {
if (variable_get('mailgun_log', FALSE)) {
watchdog('mailgun', 'Successfully sent message from %from to %to. %code: %message.', array('%from' => $mailgun_message['from'], '%to' => $mailgun_message['to'], '%code' => $result->http_response_code, '%message' => $result->http_response_body->message));
}
return TRUE;
}
else {
watchdog('mailgun', 'Failed to send message from %from to %to. %code: %message.', array('%from' => $mailgun_message['from'], '%to' => $mailgun_message['to'], '%code' => $result->http_response_code, '%message' => $result->http_response_body->message), WATCHDOG_ERROR);
return FALSE;
}
} catch (Exception $e) {
watchdog('mailgun', 'Exception occurred while trying to send test email from %from to %to. @code: @message.', array('%from' => $mailgun_message['from'], '%to' => $mailgun_message['to'], '@code' => $e->getCode(), '@message' => $e->getMessage()));
}
}