>  기사  >  백엔드 개발  >  Drupal 8 Mail API의 기능 확장: 1부

Drupal 8 Mail API의 기능 확장: 1부

PHPz
PHPz원래의
2023-08-27 20:13:081020검색

扩展 Drupal 8 Mail API 的功能:第 1 部分

2부로 구성된 이 시리즈에서는 Drupal 8의 Mail API를 살펴보겠습니다. 그 과정에서 프로그래밍 방식으로 이메일을 보내는 방법과 Mandrill과 같은 외부 서비스를 사용하도록 확장하는 방법이라는 두 가지 주요 측면을 다룰 것입니다.

이를 설명하기 위해 첫 번째 부분에서는 현재 사용자가 새 기사 노드를 저장할 때 이메일을 보내는 사용자 정의 이메일 템플릿을 만듭니다. 또한 HTML이 기본 일반 텍스트 대신 이메일 본문을 렌더링할 수 있도록 다른 사람들이 이 템플릿을 어떻게 변경했는지 살펴보겠습니다.

2부에서는 메일 시스템 확장과 이메일 전달을 위한 외부 API 통합을 살펴보겠습니다. 이를 위해 우리는 API와 상호작용하기 위한 좋은 기반을 제공하는 Mandrill과 PHP 라이브러리를 사용할 것입니다.

우리가 수행한 모든 작업은 여기에서 작성을 시작할 사용자 정의 Drupal 8 모듈의 일부로 이 Git 저장소에서 찾을 수 있습니다. 따라서 따라해보고 싶다면 자유롭게 확인해 보세요. 시작하자.

이 모듈의 첫 번째 전제 조건은 .info 파일입니다:

d8mail.info.yml:

으아아아

이 문제가 해결되면 필요에 따라 웹사이트에서 모듈을 활성화할 수 있습니다.

이메일은 어떻게 보내나요?

Drupal 8을 사용하여 프로그래밍 방식으로 이메일을 보내려면 두 가지 주요 단계가 필요합니다. 하나 이상의 이메일 템플릿을 정의하려면 먼저 Hook_mail()을 구현해야 합니다. 두 번째 단계는 메일 관리자를 통해 이러한 템플릿 중 하나를 사용하여 이메일을 보내는 것입니다.

후크라고 부르지만, hook_mail() 并不是典型的钩子,而是更多的常规函数​​,通常仅由实现它的同一模块调用。换句话说,当您以编程方式发送电子邮件时,您需要指定实现 hook_mail() 모듈 이름과 해당 후크에서 정의하고 사용하려는 템플릿 ID. 그러나 우리는 그것을 곧 보게 될 것입니다. 첫째, 어떻게 구현합니까?

d8mail.module:

으아아아

이것은 node_insert$key로 식별되는 템플릿을 정의하는 매우 간단한 구현입니다. 다른 두 가지 함수 매개변수는 다음과 같습니다.

  • $message: 참조로 전달하여 필요한 만큼 이메일에 대한 상용구를 추가합니다.
  • $params: 이메일을 보내려고 할 때 메일 관리자로부터 전달된 이메일에 입력해야 하는 추가 데이터 배열

보시다시피 우리는 이 이메일이 모든 통화에 포함할 값을 포함하는 $message 数组,其中包含我们希望此电子邮件包含在所有调用中的值。我们正在设置一个默认的 from 值,该值从配置系统检索并代表主站点电子邮件地址。我们设置一个样板电子邮件 subject ,让收件人知道创建了一个新节点,后跟节点的名称(将通过 $params 배열을 구축하고 있습니다. 구성 시스템에서 검색되고 기본 사이트 이메일 주소를 나타내는 기본 from 값을 설정하고 있습니다. 수신자에게 새 노드가 생성되었음을 알리고 그 뒤에 노드 이름(

배열을 통해 전달됨)을 알리는 상용구 이메일 제목을 설정했습니다. 주제는 호출자가 전달한 언어로 번역될 수도 있습니다.

body,因为文本可能包含 HTML,如果我们不对 HTML 元素进行编码,它可能会被截断。由于我们使用的是 SafeMarkup마지막으로 string sanitizer 클래스를 통해 메시지를 실행하므로 맨 위에 사용

이 필요합니다.

으아아아 또한 메시지 본문은 나중에 문자열로 내파

되는 배열입니다. 분명히 헤더와 같이 설정할 수 있는 다른 매개변수가 많이 있지만 이 예에서는 이것으로 충분합니다.

hook_mail()이것이

의 전부입니다. 이제 새 노드가 생성될 때마다 실행되는 코드인 Hook_entity_insert()를 살펴보겠습니다.

으아아아

이 후크는 모든 노드 저장 후에 트리거됩니다. 우리가 해야 할 일은 올바른 노드를 대상으로 하고 로직을 포함하는지 확인하는 것뿐입니다.

article노드 엔터티가

유형인지 확인한 후 Drupal Mail Manager 서비스를 로드하고 이메일에 대한 일부 값 설정을 시작합니다. 다음 정보가 필요합니다: 🎜
  • 实现 hook_mail() 并定义我们的模板(我上面提到的)的模块名称
  • 模板 ID($key
  • 收件人电子邮件地址(在当前用户帐户中找到的地址)
  • 进入 $params 数组并用于翻译主题消息的语言 ($langcode)
  • 将添加到电子邮件主题的节点标题
  • 电子邮件正文,在我们的例子中将是节点正文字段的值
  • 指示是否应实际发送电子邮件的布尔值

然后我们将所有这些值传递给邮件管理器的 mail() 方法。后者负责构建电子邮件(调用正确的 hook_mail() 实现是其中的一方面)并最终将实际交付委托给负责的插件。默认情况下,这将是 PHPMail,它使用 PHP 自带的默认 mail() 函数。

如果邮件管理器成功发送电子邮件(不考虑实际发送,而是考虑成功的 PHP 操作),则 mail() 方法将返回一个包含 result 键的数组,其中包含以下内容:邮件插件返回。通过检查该值,我们可以了解电子邮件操作是否成功,并通知用户我们已通知他们他们的操作。否则,我们将打印并记录一条错误消息。

就是这样。清除缓存并创建文章节点应该会在您的收件箱中收到一封电子邮件。如果您没有收到任何信息,并且屏幕上没有错误迹象,请务必检查服务器日志和邮件队列,以验证电子邮件是否已发出。

在继续之前,我想快速说明一下这个钩子的实现。在这个例子中,我直接将所有逻辑放在其中。此外,我在顶部使用了早期返回,这本质上意味着除了特定于文章节点的逻辑之外,不能添加其他逻辑。在实际应用程序中,我建议将邮件逻辑重构为单独的函数或类,并遵循该逻辑。此外,您不应在钩子实现中使用提前返回,而应在满足条件时调用其他函数。

我们如何更改电子邮件?

一旦所有这些都到位,我们就可以使用另一个工具来更改现有的设置:hook_mail_alter()。在负责的邮件插件发送电子邮件之前,从邮件管理器内部调用此挂钩。目的是允许其他模块对正在发送的现有电子邮件进行最终更改。

虽然其他模块也可以使用它,但我们将在我们一直使用的同一模块中说明示例实现。为此,我们将通过更改其默认标头之一来更改电子邮件,以便将其从纯文本转换为 HTML。我们可以这样做:

/**
 * Implements hook_mail_alter().
 */
function d8mail_mail_alter(&$message) {
  switch ($message['key']) {
    case 'node_insert':
      $message['headers']['Content-Type'] = 'text/html; charset=UTF-8; format=flowed; delsp=yes';
      break;
  }
}

如您所见,这是对 Content-Type 标头的简单更改,可将电子邮件转换为 HTML。这样纯文本 HTML 实体将被邮件客户端解析为 HTML。使用 switch case,我们确保这只发生在我们之前定义的电子邮件模板中。

这里需要注意的一件事是,在相关的 hook_mail() 实现之后调用 alter hook。因此,在此之后,对电子邮件进行的唯一处理是在邮件插件的 format() 方法内完成的(由其接口强制执行)。

结论

这几乎就是使用 Drupal 8 以编程方式发送电子邮件的全部内容。我们已经了解了以编程方式设置电子邮件模板所需的步骤,只要我们需要,这些模板就会由邮件管理器进行水合。我们还提到了 Drupal 8 中用于发送电子邮件的默认邮件传递插件。最后,我们看到了其他模块现在如何通过添加新标头、更改主题、将值连接到邮件正文来更改我们的电子邮件等

在下一篇文章中,我们将考虑用我们自己的自定义实现替换默认的 PHPMail 插件。我们将在 PHP 库的帮助下设置一个使用 Mandrill 的邮件程序。目标是允许我们自己的模块使用此邮件程序,而应用程序的其余部分继续使用默认的 PHPMailer。

위 내용은 Drupal 8 Mail API의 기능 확장: 1부의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명:
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.