REST Resource: users.settings.sendAs

Tài nguyên: SendAs

Các chế độ cài đặt liên kết với bí danh gửi bằng địa chỉ, 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 bằng địa chỉ tương ứng với tính năng "Gửi thư bằng địa chỉ" trong giao diện web. Bí danh gửi bằng địa chỉ phải là một địa chỉ email hợp lệ.

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. Đây là trường chỉ đọc cho 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 email đại diện này. Đối với địa chỉ "từ" tuỳ chỉnh, khi trường này trống, Gmail sẽ điền tiêu đề "Từ:" bằng tên được dùng cho địa chỉ chính liên kết với tài khoản. 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 đưa vào tiêu đề "Trả lời:" của thư được gửi bằng email đại diện này. Nếu trường này trống, Gmail sẽ không tạo tiêu đề "Trả lời:".

signature

string

Chữ ký HTML không bắt buộc được đưa vào các thư được soạn bằng email đại diện này trong giao diện người dùng web 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 hay không. Mỗi tài khoản Gmail chỉ có đúng một địa chỉ chính và bạn không thể xoá địa chỉ đó khỏi tập hợp bí danh gửi bằng địa chỉ. Trường này là trường chỉ đọ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 chỉ có đúng một địa chỉ gửi bằng địa chỉ 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. Nếu bạn thay đổi giá trị của trường này từ false thành true cho một địa chỉ, thì trường này sẽ trở thành false cho địa chỉ mặc định trước đó.

treatAsAlias

boolean

Gmail có nên coi địa chỉ này là email đại diện 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 bí danh "từ" tuỳ chỉnh.

smtpMsa

object (SmtpMsa)

Dịch vụ SMTP không bắt buộc sẽ được dùng làm dịch vụ chuyển tiếp thư gửi đi cho thư được gửi bằng bí danh này. Nếu trường này trống, thư gửi đ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 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 bằng địa chỉ hay chưa. Đây là thông tin chỉ cho phép đọc. Chế độ cài đặt này chỉ áp dụng cho 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 với dịch vụ SMTP. Đây là trường chỉ 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ỉ 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 chưa xác định.
none Hoạt động giao tiếp với dịch vụ SMTP từ xa không được bảo mật. Yêu cầu cổng 25.
ssl Hoạt động 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 quyền sở hữu một địa chỉ đã được xác minh để sử dụng làm bí danh gửi bằng địa chỉ hay chưa.

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

Phương thức

create

Tạo bí danh gửi bằng địa chỉ "từ" tuỳ chỉnh.

delete

Xoá bí danh gửi bằng địa chỉ đã chỉ định.

get

Lấy bí danh gửi bằng địa chỉ đã chỉ định.

list

Liệt kê các bí danh gửi bằng địa chỉ cho tài khoản đã chỉ định.

patch

Sửa bí danh gửi bằng địa chỉ đã chỉ định.

update

Cập nhật email đại diện gửi bằng địa chỉ.

verify

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