REST Resource: users.settings.sendAs

منبع: SendAs

تنظیمات مرتبط با نام مستعار send-as، که می‌تواند آدرس ورود اولیه مرتبط با حساب یا یک آدرس سفارشی «از» باشد. نام مستعار Send-as با ویژگی "Send Mail As" در رابط وب مطابقت دارد.

نمایندگی 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

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

isDefault

boolean

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

treatAsAlias

boolean

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

smtpMsa

object ( SmtpMsa )

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

verificationStatus

enum ( VerificationStatus )

نشان می دهد که آیا این آدرس برای استفاده به عنوان نام مستعار send-as تأیید شده است یا خیر. فقط خواندنی این تنظیم فقط برای نام‌های مستعار سفارشی «از» اعمال می‌شود.

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 استفاده شود.

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

وضعیت تأیید

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

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

روش ها

create

 یک نام مستعار send-as سفارشی "از" ایجاد می کند.

delete

 نام مستعار send-as مشخص شده را حذف می کند.

get

 نام مستعار send-as مشخص شده را دریافت می کند.

list

 نام مستعار send-as را برای حساب مشخص شده فهرست می کند.

patch

 نام مستعار send-as مشخص شده را وصله کنید.

update

 یک نام مستعار send-as را به روز می کند.

verify

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