REST Resource: users.settings.sendAs

Tài nguyên: SendAs

Chế độ cài đặt liên kết với bí danh gửi thư. Đây có thể là địa chỉ đăng nhập chính liên kết với tài khoản hoặc địa chỉ "từ" tuỳ chỉnh. Bí danh gửi thư tương ứng với tính năng "Gửi thư bằng địa chỉ" trong giao diện web.

Biểu diễn dưới dạng JSON
{
  "sendAsEmail": string,
  "displayName": string,
  "replyToAddress": string,
  "signature": string,
  "isPrimary": boolean,
  "isDefault": boolean,
  "treatAsAlias": boolean,
  "smtpMsa": {
    object (SmtpMsa)
  },
  "verificationStatus": enum (VerificationStatus)
}
Trường
sendAsEmail

string

Địa chỉ email xuất hiện trong tiêu đề "Từ:" của thư được gửi bằng email đại diện này. Quyền này chỉ có thể đọc đối với tất cả các thao tác ngoại trừ thao tác tạo.

displayName

string

Tên xuất hiện trong tiêu đề "Từ:" của thư được gửi bằng bí danh này. Đối với địa chỉ "từ" tuỳ chỉnh, khi địa chỉ này trống, Gmail sẽ điền tên được dùng cho địa chỉ chính được liên kết với tài khoản vào tiêu đề "Từ:". Nếu quản trị viên đã tắt tính năng cho phép người dùng cập nhật định dạng tên, thì các yêu cầu cập nhật trường này cho thông tin đăng nhập chính sẽ không thành công.

replyToAddress

string

Địa chỉ email không bắt buộc có trong tiêu đề "Reply-To:" (Trả lời:) cho thư được gửi bằng bí danh này. Nếu trường này trống, Gmail sẽ không tạo tiêu đề "Reply-To:" (Trả lời:).

signature

string

Chữ ký HTML không bắt buộc có trong thư được soạn bằng bí danh này trong giao diện người dùng web của Gmail. Chữ ký này chỉ được thêm vào email mới.

isPrimary

boolean

Địa chỉ này có phải là địa chỉ chính dùng để đăng nhập vào tài khoản không. Mỗi tài khoản Gmail có đúng một địa chỉ chính và bạn không thể xoá địa chỉ này khỏi tập hợp các địa chỉ đại diện gửi thư. Trường này chỉ có thể đọc.

isDefault

boolean

Địa chỉ này có được chọn làm địa chỉ "Từ:" mặc định trong các trường hợp như soạn thư mới hoặc gửi thư trả lời tự động khi đi nghỉ hay không. Mỗi tài khoản Gmail có đúng một địa chỉ gửi dưới dạng mặc định, vì vậy, giá trị hợp lệ duy nhất mà ứng dụng có thể ghi vào trường này là true. Việc thay đổi giá trị này từ false thành true cho một địa chỉ sẽ khiến trường này trở thành false cho địa chỉ mặc định trước đó khác.

treatAsAlias

boolean

Liệu Gmail có nên coi địa chỉ này là bí danh cho địa chỉ email chính của người dùng hay không. Chế độ cài đặt này chỉ áp dụng cho các bí danh "từ" tuỳ chỉnh.

smtpMsa

object (SmtpMsa)

Một dịch vụ SMTP không bắt buộc sẽ được dùng làm dịch vụ chuyển tiếp thư đi cho thư được gửi bằng bí danh này. Nếu trường này trống, thư đi sẽ được gửi trực tiếp từ máy chủ của Gmail đến dịch vụ SMTP đích. Chế độ cài đặt này chỉ áp dụng cho các bí danh "từ" tuỳ chỉnh.

verificationStatus

enum (VerificationStatus)

Cho biết địa chỉ này đã được xác minh để sử dụng làm bí danh gửi thư hay chưa. Chỉ có thể đọc. Chế độ cài đặt này chỉ áp dụng cho các bí danh "từ" tuỳ chỉnh.

SmtpMsa

Cấu hình để giao tiếp với dịch vụ SMTP.

Biểu diễn dưới dạng JSON
{
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
Trường
host

string

Tên máy chủ của dịch vụ SMTP. Bắt buộc.

port

integer

Cổng của dịch vụ SMTP. Bắt buộc.

username

string

Tên người dùng sẽ được dùng để xác thực bằng dịch vụ SMTP. Đây là trường chỉ có thể ghi, có thể được chỉ định trong các yêu cầu tạo hoặc cập nhật chế độ cài đặt SendAs; trường này không bao giờ được điền trong các phản hồi.

password

string

Mật khẩu sẽ được dùng để xác thực với dịch vụ SMTP. Đây là trường chỉ có thể ghi, có thể được chỉ định trong các yêu cầu tạo hoặc cập nhật chế độ cài đặt SendAs; trường này không bao giờ được điền trong các phản hồi.

securityMode

enum (SecurityMode)

Giao thức sẽ được dùng để bảo mật hoạt động giao tiếp với dịch vụ SMTP. Bắt buộc.

SecurityMode

Giao thức có thể được dùng để bảo mật hoạt động giao tiếp với dịch vụ SMTP.

Enum
securityModeUnspecified Chế độ bảo mật không xác định.
none Giao tiếp với dịch vụ SMTP từ xa không an toàn. Yêu cầu cổng 25.
ssl Thông tin giao tiếp với dịch vụ SMTP từ xa được bảo mật bằng SSL.
starttls Hoạt động giao tiếp với dịch vụ SMTP từ xa được bảo mật bằng STARTTLS.

VerificationStatus

Cho biết liệu quyền sở hữu của một địa chỉ đã được xác minh để sử dụng làm bí danh gửi dưới dạng hay chưa.

Enum
verificationStatusUnspecified Trạng thái xác minh không xác định.
accepted Địa chỉ này đã sẵn sàng để sử dụng làm bí danh gửi thư.
pending Địa chỉ này đang chờ chủ sở hữu xác minh.

Phương thức

create

Tạo bí danh "từ" tuỳ chỉnh để gửi email.

delete

Xoá bí danh gửi thư đã chỉ định.

get

Lấy bí danh gửi dưới dạng được chỉ định.

list

Liệt kê các bí danh gửi dưới danh nghĩa cho tài khoản đã chỉ định.

patch

Vá bí danh gửi dưới dạng đã chỉ định.

update

Cập nhật bí danh gửi dưới dạng.

verify

Gửi email xác minh đến địa chỉ đại diện gửi thư đã chỉ định.