SendGrid PHP API 库使用教程

SendGrid PHP API 库使用教程

sendgrid-phpThe Official Twilio SendGrid PHP API Library项目地址:https://gitcode.com/gh_mirrors/se/sendgrid-php

1. 项目的目录结构及介绍

SendGrid PHP API 库的目录结构如下：

sendgrid-php/
├── LICENSE
├── README.md
├── SECURITY.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── USE_CASES.md
├── CHANGELOG.md
├── composer.json
├── composer.lock
├── examples/
│   ├── example.php
│   └── ...
├── lib/
│   ├── client.php
│   ├── mail/
│   │   ├── mail.php
│   │   └── ...
│   └── ...
├── test/
│   ├── sendgrid_test.php
│   └── ...
└── sendgrid-php.php

目录介绍

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• SECURITY.md: 安全相关说明。
• CODE_OF_CONDUCT.md: 行为准则。
• CONTRIBUTING.md: 贡献指南。
• USE_CASES.md: 使用案例文档。
• CHANGELOG.md: 版本变更记录。
• composer.json 和 composer.lock: Composer 依赖管理文件。
• examples/: 示例代码目录。
• lib/: 库的核心代码目录。
• test/: 测试代码目录。
• sendgrid-php.php: 主库文件。

2. 项目的启动文件介绍

SendGrid PHP API 库的启动文件是 sendgrid-php.php。这个文件包含了库的主要功能和类定义。在使用库之前，需要引入这个文件。

require_once 'path/to/sendgrid-php.php';

3. 项目的配置文件介绍

SendGrid PHP API 库没有专门的配置文件，但你需要在代码中设置 API 密钥。以下是一个简单的配置示例：

<?php
require 'vendor/autoload.php'; // 如果你使用 Composer

use SendGrid\Mail\Mail;

$email = new Mail();
$email->setFrom("example@example.com", "Example User");
$email->setSubject("Sending with Twilio SendGrid is Fun");
$email->addTo("test@example.com", "Example User");
$email->addContent("text/plain", "and easy to do anywhere, even with PHP");
$email->addContent(
    "text/html", "<strong>and easy to do anywhere, even with PHP</strong>"
);

$sendgrid = new \SendGrid(getenv('SENDGRID_API_KEY'));
try {
    $response = $sendgrid->send($email);
    print $response->statusCode() . "\n";
    print_r($response->headers());
    print $response->body() . "\n";
} catch (Exception $e) {
    echo 'Caught exception: ',  $e->getMessage(), "\n";
}

在这个示例中，你需要设置 SENDGRID_API_KEY 环境变量来存储你的 SendGrid API 密钥。

sendgrid-phpThe Official Twilio SendGrid PHP API Library项目地址:https://gitcode.com/gh_mirrors/se/sendgrid-php