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

آدرس ایمیلی که در سربرگ "From:" برای ایمیل‌های ارسالی با این نام مستعار نمایش داده می‌شود. این آدرس برای همه عملیات‌ها به جز ایجاد، فقط خواندنی است.

displayName

string

نامی که در سربرگ "From:" برای ایمیل‌های ارسالی با استفاده از این نام مستعار ظاهر می‌شود. برای آدرس‌های سفارشی "from"، وقتی این نام خالی باشد، Gmail سربرگ "From:" را با نامی که برای آدرس اصلی مرتبط با حساب استفاده می‌شود، پر می‌کند. اگر مدیر امکان به‌روزرسانی قالب نام را برای کاربران غیرفعال کرده باشد، درخواست‌ها برای به‌روزرسانی این فیلد برای ورود اصلی بی‌سروصدا با شکست مواجه می‌شوند.

replyToAddress

string

یک آدرس ایمیل اختیاری که در سربرگ «پاسخ به:» برای ایمیل‌های ارسالی با استفاده از این نام مستعار درج می‌شود. اگر این فیلد خالی باشد، جیمیل سربرگ «پاسخ به:» را ایجاد نمی‌کند.

signature

string

یک امضای HTML اختیاری که در پیام‌های تشکیل‌شده با این نام مستعار در رابط کاربری وب Gmail گنجانده شده است. این امضا فقط به ایمیل‌های جدید اضافه می‌شود.

isPrimary

boolean

اینکه آیا این آدرس، آدرس اصلی مورد استفاده برای ورود به حساب کاربری است یا خیر. هر حساب جیمیل دقیقاً یک آدرس اصلی دارد و نمی‌توان آن را از مجموعه نام‌های مستعار ارسالی حذف کرد. این فیلد فقط خواندنی است.

isDefault

boolean

اینکه آیا این آدرس به عنوان آدرس پیش‌فرض "From:" در موقعیت‌هایی مانند نوشتن پیام جدید یا ارسال پاسخ خودکار تعطیلات انتخاب می‌شود یا خیر. هر حساب Gmail دقیقاً یک آدرس پیش‌فرض ارسال دارد، بنابراین تنها مقدار قانونی که کاربران می‌توانند در این فیلد بنویسند، true است. تغییر این مقدار از false به true برای یک آدرس، منجر به false شدن این فیلد برای آدرس پیش‌فرض قبلی دیگر می‌شود.

treatAsAlias

boolean

اینکه آیا جیمیل باید این آدرس را به عنوان نام مستعار آدرس ایمیل اصلی کاربر در نظر بگیرد یا خیر. این تنظیم فقط برای نام‌های مستعار سفارشی «از» اعمال می‌شود.

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 استفاده خواهد شد. الزامی.

حالت امنیتی

پروتکلی که ممکن است برای ایمن‌سازی ارتباط با سرویس SMTP استفاده شود.

انوم‌ها
securityModeUnspecified حالت امنیتی نامشخص.
none ارتباط با سرویس SMTP از راه دور ناامن است. به پورت ۲۵ نیاز دارد.
ssl ارتباط با سرویس SMTP از راه دور با استفاده از SSL ایمن می‌شود.
starttls ارتباط با سرویس SMTP از راه دور با استفاده از STARTTLS ایمن می‌شود.

وضعیت تأیید

نشان می‌دهد که آیا مالکیت یک آدرس برای استفاده به عنوان نام مستعار ارسالی تأیید شده است یا خیر.

انوم‌ها
verificationStatusUnspecified وضعیت تأیید نامشخص.
accepted آدرس آماده استفاده به عنوان نام مستعار ارسالی است.
pending آدرس در انتظار تأیید توسط مالک است.

روش‌ها

create

 یک نام مستعار سفارشی برای ارسال از نوع "from" ایجاد می‌کند.

delete

 نام مستعار ارسالی مشخص شده را حذف می‌کند.

get

 نام مستعار ارسال به عنوان مشخص شده را دریافت می‌کند.

list

 نام‌های مستعار ارسالی برای حساب مشخص‌شده را فهرست می‌کند.

patch

 نام مستعار ارسالی مشخص شده را اصلاح کنید.

update

 یک نام مستعار ارسالی را به‌روزرسانی می‌کند.

verify

 یک ایمیل تأیید به آدرس ایمیل مستعار ارسالی مشخص شده ارسال می‌کند.