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.

טיפוסים בני מנייה (enums)
securityModeUnspecified מצב האבטחה לא צוין.
none התקשורת עם שירות ה-SMTP המרוחק אינה מאובטחת. נדרשת יציאה 25.
ssl התקשורת עם שירות ה-SMTP המרוחק מאובטחת באמצעות SSL.
starttls התקשורת עם שירות ה-SMTP המרוחק מאובטחת באמצעותSTARTTLS.

VerificationStatus

מציין אם הבעלות על כתובת אומתה עבור השימוש בה ככינוי לשליחה.

טיפוסים בני מנייה (enums)
verificationStatusUnspecified סטטוס האימות לא צוין.
accepted הכתובת מוכנה לשימוש ככינוי לשליחה.
pending הכתובת ממתינה לאימות על ידי הבעלים.

שיטות

create

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

delete

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

get

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

list

מציין את כתובות האימייל החלופיות 'שלח כ' עבור החשבון שצוין.

patch

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

update

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

verify

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