Port project_issue to use the D6 drupal_mail()

Also related:

• Converting 5.x modules to 6.x » Drupal 5.x to 6.x Mail changes
• hook_mail

Attached is a first stab at converting "mail.inc" from the old drupal_mail format to the new one.

The original contents of project_mail_notify have been split up into:

project_mail_notify()

Still does the brunt of the work when it comes to fetching issue- & project-information and building the list of "connected users"

project_issue_mail()

An implementation of hook_mail, as required by the new drupal_mail function. This is where the cosmetic stuff happens

I have tried to keep the original logic whenever possible, and refrained from making any other changes than those required for the port itself. I did have to juggle some of the sections around. So far my tests have been limited to just a couple of issues/comments/users, but it seems to be running as it should without any errors. I'll be running a larger battery of tests later on to confirm that everything is working as expected.

PS. the subscribe page at /projects/issues/subscribe-mail is currently not usable, so on fresh install you might have to insert some records into project_subscriptions if you want to review/test this patch.

All comments welcome!

In D6, node_access() takes a new optional 3rd parameter, $account. Do we want to alter the call to node_access() to use this parameter when we check to see if a user should get the email or not.

I think that definitely makes sense. I've changed the following code

 if ($check_node_access) {
      // Load the user that's to receive the mail into
      // the global user object temporarily. We use session_save_session()
      // to provide safe user impersonation.
      $original_user = $user;
      session_save_session(FALSE);
      $user = $account;
      $can_access = node_access('view', $node);
      // Load the original user back in.
      $user = $original_user;
      session_save_session(TRUE);
    }
    else {
      $can_access = TRUE;
    }

to:

$can_access = $check_node_access ? node_access('view', $node, $account) : TRUE;

Additional changes:

• I've made a number of (smaller) changes after running the coder module against the patched mail.inc file
• The $language for the email is now set to user_preferred_language(), as advised by the drupal_mail documentation. Currently it doesn't matter what the language is set to, but it's passed to project_issue_mail as $message['language'], which means other modules that want to override the outgoing email via hook_mail_alter can take it into account.
• An error in the original patch caused all the emails to have the raw site admin email address as sender, which has now been fixed.

Attached is an updated patch. Although it seems to work as advertised and without any errors, I'm going to keep this issue at CNW until I have been able to run a larger batch of tests. I'm having some problems getting issue generation to work on my D6 test site, so I'll be addressing that first.

And one question: currently there's only one include, cron.inc, in the includes-folder, and three in the root (mail.inc, issue.inc & comment.inc). Should we move these into the includes-folder as well to keep things tidy? If yes, I think moving mail.inc into includes should be addressed as part of this issue.

B) project_mail_generate_followup_mail_body() is still broken. You don't get any of the info about the issue metadata changes for each comment in the email.

I don't think I understand what you mean by this one. No changes were made to project_mail_generate_followup_mail_body() in this patch, but the emails I receive contain the metadata changes table at the top of each email, including the "change markers". Should the same metadata table be displayed for each comment in the history also? This doesn't seem to be the case for the emails currently sent for d.o. issue updates.