XU XUv0.8.8
EN

API

#github.com/xulang-org/packages/smtp

import: smtp #github.com/xulang-org/packages/smtp

counts: 5 函数, 7 方法, 4 类型, 0 常量, 0 方法集

扩展包 `smtp #github.com/xulang-org/packages/smtp`，由模块 github.com/xulang-org/packages 提供。

github.com/xulang-org/packages · 0.1.1 · 安装与使用

client

XuAPI
pub fn client(endpoint string) SmtpClient

用途

客户端。

参数

endpoint string
endpoint（string）

返回

SmtpClient — 该类型的值

pool

XuAPI
pub fn pool(endpoint string, max_conns int) SmtpPool

用途

pool，返回 SmtpPool。

参数

endpoint string
endpoint（string）
max_conns int
max_conns（int）

返回

SmtpPool — 该类型的值

struct Message

XuAPI
pub struct Message {
    pub from string
    pub to string
    pub subject string
    pub body string
}

用途

公开结构体 `Message`。

参数

from string
字段（string）
to string
字段（string）
subject string
字段（string）
body string
正文

struct SmtpClient

XuAPI
pub struct SmtpClient {
    pub host string
    pub port int
    pub username string
    pub password string
}

用途

公开结构体 `SmtpClient`。

参数

host string
主机
port int
端口
username string
字段（string）
password string
字段（string）

struct SmtpResponse

XuAPI
pub struct SmtpResponse {
    pub code int
    pub text string
}

用途

公开结构体 `SmtpResponse`。

参数

code int
码
text string
文本

read_response

XuAPI
pub fn read_response(fd int) SmtpResponse

用途

读取响应。失败时 throw。

参数

fd int
文件描述符（int）

返回

SmtpResponse — 该类型的值

new_client

XuAPI
pub fn new_client(endpoint string) SmtpClient

用途

构造 client。

参数

endpoint string
endpoint（string）

返回

SmtpClient — 该类型的值

(SmtpClient) connect

XuAPI
pub fn (c SmtpClient) connect() int

用途

在 `SmtpClient` 上调用 `connect`。失败时 throw。

参数

c SmtpClient
接收者 SmtpClient（值接收者）

返回

int — 该类型的值

(SmtpClient) send_mail_on_fd

XuAPI
pub fn (c SmtpClient) send_mail_on_fd(fd int, msg Message) bool

用途

`SmtpClient` 上的方法：sendmail于fd。失败时 throw。

参数

c SmtpClient
接收者 SmtpClient（值接收者）
fd int
文件描述符（int）
msg Message
消息（Message）

返回

bool — 是否成立

(SmtpClient) close_conn

XuAPI
pub fn (c SmtpClient) close_conn(fd int)

用途

`SmtpClient` 上的方法：关闭连接。

参数

c SmtpClient
接收者 SmtpClient（值接收者）
fd int
文件描述符（int）

struct SmtpPool

XuAPI
pub struct SmtpPool {
    pub client SmtpClient
    pub idle chan int
    pub max_idle int
}

用途

公开结构体 `SmtpPool`。

参数

client SmtpClient
字段（SmtpClient）
idle chan int
字段（通道；类型 chan int）
max_idle int
字段（int）

open_pool

XuAPI
pub fn open_pool(endpoint string, max_idle int) SmtpPool

用途

打开pool。

参数

endpoint string
endpoint（string）
max_idle int
max_idle（int）

返回

SmtpPool — 该类型的值

(&SmtpPool) get_conn

XuAPI
pub fn (p &SmtpPool) get_conn() int

用途

`&SmtpPool` 上的方法：读取 conn。

参数

p &SmtpPool
接收者 &SmtpPool（借用）

返回

int — 该类型的值

(&SmtpPool) put_conn

XuAPI
pub fn (p &SmtpPool) put_conn(fd int)

用途

`&SmtpPool` 上的方法：put连接。

参数

p &SmtpPool
接收者 &SmtpPool（借用）
fd int
文件描述符（int）

(&SmtpPool) send_mail

XuAPI
pub fn (p &SmtpPool) send_mail(msg Message) bool

用途

`&SmtpPool` 上的方法：sendmail。失败时 throw。

参数

p &SmtpPool
接收者 &SmtpPool（借用）
msg Message
消息（Message）

返回

bool — 是否成立

(&SmtpPool) close

XuAPI
pub fn (p &SmtpPool) close()

用途

`&SmtpPool` 上的方法：关闭资源。

参数

p &SmtpPool
接收者 &SmtpPool（借用）