REST Resource: users.settings.sendAs

แหล่งข้อมูล: SendAs

การตั้งค่าที่เชื่อมโยงกับชื่อแทนที่ใช้ส่ง ซึ่งอาจเป็นที่อยู่หลักสำหรับเข้าสู่ระบบที่เชื่อมโยงกับบัญชีหรือที่อยู่ "จาก" ที่กำหนดเองก็ได้ อีเมลแทนจะสอดคล้องกับฟีเจอร์ "ส่งอีเมลในชื่อ" ในอินเทอร์เฟซบนเว็บ

การแสดง JSON
{
  "sendAsEmail": string,
  "displayName": string,
  "replyToAddress": string,
  "signature": string,
  "isPrimary": boolean,
  "isDefault": boolean,
  "treatAsAlias": boolean,
  "smtpMsa": {
    object (SmtpMsa)
  },
  "verificationStatus": enum (VerificationStatus)
}
ช่อง
sendAsEmail

string

อีเมลที่ปรากฏในส่วนหัว "จาก:" สำหรับอีเมลที่ส่งโดยใช้ชื่อแทนนี้ ตัวเลือกนี้จะเป็นแบบอ่านอย่างเดียวสำหรับการดำเนินการทั้งหมด ยกเว้น "สร้าง"

displayName

string

ชื่อที่ปรากฏในส่วนหัว "จาก:" สำหรับอีเมลที่ส่งโดยใช้ชื่อแทนนี้ สำหรับที่อยู่ "จาก" ที่กำหนดเอง เมื่อเว้นว่างไว้ Gmail จะสร้างส่วนหัว "จาก:" ด้วยชื่อที่ใช้สำหรับที่อยู่หลักที่เชื่อมโยงกับบัญชี หากผู้ดูแลระบบปิดไม่ให้ผู้ใช้อัปเดตรูปแบบชื่อ คำขออัปเดตช่องนี้สำหรับการเข้าสู่ระบบหลักจะดำเนินการไม่สำเร็จโดยไม่มีการแจ้งเตือน

replyToAddress

string

ที่อยู่อีเมล (ไม่บังคับ) ที่รวมอยู่ในส่วนหัว "ตอบกลับ:" สำหรับอีเมลที่ส่งโดยใช้ชื่อแทนนี้ หากเว้นว่างส่วนนี้ Gmail จะไม่สร้างส่วนหัว "ตอบกลับ:"

signature

string

ลายเซ็น HTML (ไม่บังคับ) ที่จะรวมอยู่ในข้อความที่เขียนด้วยชื่อแทนนี้ใน UI ทางเว็บของ Gmail ลายเซ็นนี้จะเพิ่มลงในอีเมลใหม่เท่านั้น

isPrimary

boolean

ที่อยู่นี้เป็นที่อยู่หลักที่ใช้ในการเข้าสู่ระบบบัญชีหรือไม่ บัญชี Gmail ทุกบัญชีจะมีที่อยู่หลักเพียงที่อยู่เดียว และไม่สามารถลบออกจากคอลเล็กชันชื่อแทนที่ใช้ส่งได้ ช่องนี้เป็นแบบอ่านอย่างเดียว

isDefault

boolean

ที่อยู่นี้จะถูกเลือกเป็นที่อยู่ "จาก:" ตามค่าเริ่มต้นในสถานการณ์ต่างๆ เช่น การเขียนข้อความใหม่ หรือการส่งการตอบกลับอัตโนมัติในวันหยุด บัญชี Gmail ทุกบัญชีจะมีที่อยู่ "ส่งเป็น" เริ่มต้นเพียง 1 รายการ ดังนั้นค่าทางกฎหมายเพียงค่าเดียวที่ไคลเอ็นต์อาจเขียนลงในช่องนี้ก็คือ true การเปลี่ยนจาก false เป็น true สำหรับที่อยู่หนึ่งจะทำให้ช่องนี้กลายเป็น false สำหรับที่อยู่เริ่มต้นอื่นๆ ก่อนหน้านี้

treatAsAlias

boolean

กำหนดว่า Gmail ควร ปฏิบัติกับที่อยู่นี้เป็นชื่อแทนสำหรับที่อยู่อีเมลหลักของผู้ใช้หรือไม่ การตั้งค่านี้จะมีผลกับชื่อแทน "จาก" ที่กำหนดเองเท่านั้น

smtpMsa

object (SmtpMsa)

บริการ SMTP ทางเลือกที่จะใช้เป็นการส่งต่อขาออกสำหรับอีเมลที่ส่งโดยใช้ชื่อแทนนี้ หากเว้นว่างค่านี้ไว้ อีเมลขาออกจะส่งจากเซิร์ฟเวอร์ Gmail ไปยังบริการ SMTP ปลายทางโดยตรง การตั้งค่านี้จะมีผลกับชื่อแทน "จาก" ที่กำหนดเองเท่านั้น

verificationStatus

enum (VerificationStatus)

ระบุว่าที่อยู่นี้ได้รับการยืนยันเพื่อใช้เป็นชื่อแทนที่ใช้ส่งหรือไม่ อ่านอย่างเดียว การตั้งค่านี้จะมีผลกับชื่อแทน "จาก" ที่กำหนดเองเท่านั้น

SmtpMsa

การกำหนดค่าสำหรับการสื่อสารกับบริการ SMTP

การแสดง JSON
{
  "host": string,
  "port": integer,
  "username": string,
  "password": string,
  "securityMode": enum (SecurityMode)
}
ช่อง
host

string

ชื่อโฮสต์ของบริการ SMTP ต้องระบุ

port

integer

พอร์ตของบริการ SMTP ต้องระบุ

username

string

ชื่อผู้ใช้ที่จะใช้สำหรับตรวจสอบสิทธิ์กับบริการ SMTP ช่องนี้เป็นช่องสำหรับเขียนอย่างเดียวที่สามารถระบุไว้ในคำขอสร้างหรืออัปเดตการตั้งค่า SendAs และจะไม่มีการป้อนข้อมูลในคำตอบ

password

string

รหัสผ่านที่จะใช้สำหรับการตรวจสอบสิทธิ์กับบริการ SMTP ช่องนี้เป็นช่องสำหรับเขียนอย่างเดียวที่สามารถระบุไว้ในคำขอสร้างหรืออัปเดตการตั้งค่า SendAs และจะไม่มีการป้อนข้อมูลในคำตอบ

securityMode

enum (SecurityMode)

โปรโตคอลที่จะใช้เพื่อรักษาความปลอดภัยในการสื่อสารกับบริการ SMTP ต้องระบุ

SecurityMode

โปรโตคอลที่ใช้เพื่อรักษาความปลอดภัยในการสื่อสารกับบริการ SMTP

Enum
securityModeUnspecified ไม่ได้ระบุโหมดความปลอดภัย
none การสื่อสารกับบริการ SMTP ระยะไกลไม่มีการรักษาความปลอดภัย ต้องใช้พอร์ต 25
ssl การสื่อสารกับบริการ SMTP ระยะไกลจะได้รับการรักษาความปลอดภัยโดยใช้ SSL
starttls การสื่อสารกับบริการ SMTP ระยะไกลจะได้รับการรักษาความปลอดภัยด้วย STARTTLS

VerificationStatus

ระบุว่าได้รับการยืนยันการเป็นเจ้าของอีเมลสำหรับการใช้เป็นชื่อแทนสำหรับการส่งหรือไม่

Enum
verificationStatusUnspecified สถานะการยืนยันที่ไม่ได้ระบุ
accepted ที่อยู่นี้พร้อมใช้เป็นชื่อแทนสำหรับการส่งแล้ว
pending ที่อยู่กำลังรอการยืนยันโดยเจ้าของ

วิธีการ

create

สร้างชื่อแทนการส่ง "จาก" ที่กำหนดเอง

delete

ลบชื่อแทนที่ใช้ส่งที่ระบุ

get

รับชื่อแทนที่ใช้ส่งที่ระบุ

list

แสดงชื่อแทนที่ใช้ส่งสำหรับบัญชีที่ระบุ

patch

แพตช์ชื่อแทนการส่งที่ระบุ

update

อัปเดตชื่อแทนที่ใช้ส่งเป็น

verify

ส่งอีเมลยืนยันไปยังที่อยู่อีเมลแทนที่ระบุ