Joomla! API

下载
启动

Emails

扩展自 AbstractPackage

Joomla 框架的 GitHub API Emails 类。

通过 API 管理电子邮件地址需要您通过基本身份验证或 OAuth 以及用户范围进行身份验证。

链接
自

1.0
包

Joomla 框架

方法

__construct

构造函数。

__construct(\Joomla\Registry\Registry options = null, \Joomla\Http\Http client = null) :
继承
自

1.0

参数

options

Registry|nullGitHub 选项对象。

client

Http|nullHTTP 客户端对象。

响应

混合

__get

延迟创建 API 对象的魔术方法

__get( name) : \Joomla\Github\AbstractPackage
继承
自

1.0
抛出

InvalidArgumentException

参数

name

string要检索的属性名称

响应

AbstractPackageGitHub API 包对象。

add

添加电子邮件地址。

add(string|array email) :
自

1.0

参数

email

string|array<string|int, mixed>电子邮件地址。

响应

对象

delete

删除电子邮件地址。

delete(string|array email) :
自

1.0

参数

email

string|array<string|int, mixed>电子邮件地址。

响应

对象

fetchUrl

构建并返回请求的完整请求 URL 的方法。此方法将在必要时添加适当的分页详细信息，并将 API URL 作为前缀以获得请求的完整 URL。

fetchUrl( path,  page,  limit) : \Joomla\Uri\Uri
继承
自

1.0

参数

path

string要变形的 URL

page

int要请求的页码

limit

int每页返回的结果数

响应

Uri

getList

列出用户的电子邮件地址。

getList() :
自

1.0

响应

对象

processResponse

处理响应并对其进行解码。

processResponse(\Joomla\Http\Response response,  expectedCode = 200) :
继承
自

1.0
抛出

UnexpectedResponseException

参数

response

Response响应。

expectedCode

int预期的“良好”代码。

响应

混合

属性

options

GitHub 对象的选项。

继承
自

1.0

类型

Registry

client

用于发送 HTTP 请求的 HTTP 客户端对象。

继承
自

1.0

类型

Http

包

对象所在的包

继承
自

1.0

类型

string

hookEvents

包含允许的挂钩事件的数组

继承
自

1.5.2
链接
注意

从 1.4.0 到 1.5.1，此名称为 $events，由于与包子类的命名冲突，因此已重命名

类型

array<string|int, mixed>
  • \ Joomla
  • \ Github
  • \ Package
  • \ Users
  • \ Emails