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

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