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 לא ייצור כותרת Reply-To:‎.
signature

string

חתימת HTML אופציונלית שכלולה בהודעות שנוצרות באמצעות הכתובת החלופית הזו בממשק המשתמש של Gmail באינטרנט. החתימה הזו תתווסף לאימיילים חדשים בלבד.
isPrimary

boolean

האם זו הכתובת הראשית שמשמשת לכניסה לחשבון. לכל חשבון Gmail יש כתובת ראשית אחת בלבד, ואי אפשר למחוק אותה מהאוסף של כתובות האימייל החלופיות לצורך שליחה. השדה הזה הוא לקריאה בלבד.
isDefault

boolean

אם הכתובת הזו תיבחר ככתובת ברירת המחדל של 'מאת:' במצבים כמו כתיבת הודעה חדשה או שליחת תשובה אוטומטית על חופשה. לכל חשבון Gmail יש כתובת ברירת מחדל אחת ל'שליחה כ', ולכן הערך היחיד שתוכנות לקוח יכולות לכתוב בשדה הזה הוא 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 הכתובת ממתינה לאימות על ידי הבעלים.

Methods

create

 יצירת כינוי 'מאת' בהתאמה אישית לשליחה כ'מאת'.

delete

 מחיקת כתובת האימייל החלופית שצוינה לשליחה.

get

 הפונקציה מקבלת את כתובת האימייל החלופית שצוינה לשליחה.

list

 הצגת כתובות האימייל החלופיות לשליחה בשם החשבון שצוין.

patch

 תיקון התיקון של הכינוי לשליחה בתור שצוין.

update

 עדכון של כתובת אימייל חלופית לשליחה.

verify

 שליחת הודעת אימות לכתובת החלופית שצוינה לשליחה.