900 lines
91 KiB
XML
900 lines
91 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<doc>
|
||
<assembly>
|
||
<name>ASC.Api.Mail</name>
|
||
</assembly>
|
||
<members>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetFilters">
|
||
<summary>Возвращает список тегов, используемых в Почте</summary>
|
||
<returns>Список фильтров. Фильтры, представленные в виде JSON.</returns>
|
||
<short>Получить список фильтров</short>
|
||
<category>Фильтры</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.CreateFilter(ASC.Mail.Data.Contracts.MailSieveFilterData)">
|
||
<summary>Создает новый фильтр</summary>
|
||
<param name="filter"></param>
|
||
<returns>Фильтр</returns>
|
||
<short>Создать фильтр</short>
|
||
<category>Фильтры</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.UpdateFilter(ASC.Mail.Data.Contracts.MailSieveFilterData)">
|
||
<summary>Обновляет выбранный фильтр</summary>
|
||
<param name="filter"></param>
|
||
<returns>Обновленный фильтр</returns>
|
||
<short>Обновить фильтр</short>
|
||
<category>Фильтры</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.DeleteFilter(System.Int32)">
|
||
<summary>Удаляет выбранный фильтр</summary>
|
||
<param name="id">ИД фильтра</param>
|
||
<returns>ИД удаляемого фильтра</returns>
|
||
<short>Удалить фильтр</short>
|
||
<category>Фильтры</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.CheckFilter(ASC.Mail.Data.Contracts.MailSieveFilterData,System.Nullable{System.Int32},System.Nullable{System.Int32})">
|
||
<summary>Проверить результат применения фильтра</summary>
|
||
<param name="filter"></param>
|
||
<param optional="true" name="page">Номер страницы</param>
|
||
<param optional="true" name="pageSize">Количество сообщений на странице</param>
|
||
<returns>Перечислить сообщения</returns>
|
||
<short>Проверить фильтр</short>
|
||
<category>Фильтры</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.ApplyFilter(System.Int32)">
|
||
<summary>Применить фильтр к существующим сообщениям</summary>
|
||
<param name="id">ИД фильтра</param>
|
||
<returns>Объект MailOperationResult</returns>
|
||
<short>Проверить фильтр</short>
|
||
<category>Фильтры</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetMailServerInfo">
|
||
<visible>false</visible>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.ConnectMailServer(System.String,System.String,System.String,System.String)">
|
||
<visible>false</visible>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SaveMailServerInfo(System.String,System.String,System.String,System.String,System.String,System.String)">
|
||
<visible>false</visible>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.ConnectAndSaveMailServerInfo(System.String,System.String,System.String)">
|
||
<visible>false</visible>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.ConnectAndSavePartitionalMailServerInfo(System.String,System.String,System.String,System.String)">
|
||
<visible>false</visible>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetCommonSettings">
|
||
<summary>Возвращает общие настройки</summary>
|
||
<returns>Объект MailCommonSettings</returns>
|
||
<short>Получить общие настройки</short>
|
||
<category>Настройки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetEnableConversationFlag">
|
||
<summary>Возвращает флаг EnableConversations</summary>
|
||
<returns>логическое значение</returns>
|
||
<short>Получить флаг EnableConversations</short>
|
||
<category>Настройки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SetEnableConversationFlag(System.Boolean)">
|
||
<summary>Задать флаг EnableConversations</summary>
|
||
<param name="enabled">Значение True или False</param>
|
||
<short>Задать флаг EnableConversations</short>
|
||
<category>Настройки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetAlwaysDisplayImagesFlag">
|
||
<summary>Возвращает флаг AlwaysDisplayImages</summary>
|
||
<returns>логическое значение</returns>
|
||
<short>Получить флаг AlwaysDisplayImages</short>
|
||
<category>Настройки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SetAlwaysDisplayImagesFlag(System.Boolean)">
|
||
<summary>Задать флаг AlwaysDisplayImages</summary>
|
||
<param name="enabled">Значение True или False</param>
|
||
<short>Задать флаг AlwaysDisplayImages</short>
|
||
<category>Настройки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetCacheUnreadMessagesFlag">
|
||
<summary>Возвращает флаг CacheUnreadMessages</summary>
|
||
<returns>логическое значение</returns>
|
||
<short>Получить флаг CacheUnreadMessages</short>
|
||
<category>Настройки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SetCacheUnreadMessagesFlag(System.Boolean)">
|
||
<summary>Задать флаг CacheUnreadMessages</summary>
|
||
<param name="enabled">Значение True или False</param>
|
||
<short>Задать флаг CacheUnreadMessages</short>
|
||
<category>Настройки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetEnableGoNextAfterMoveFlag">
|
||
<summary>Возвращает флаг GoNextAfterMove</summary>
|
||
<returns>логическое значение</returns>
|
||
<short>Получить флаг GoNextAfterMove</short>
|
||
<category>Настройки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SetEnableGoNextAfterMoveFlag(System.Boolean)">
|
||
<summary>Задать флаг GoNextAfterMove</summary>
|
||
<param name="enabled">Значение True или False</param>
|
||
<short>Задать флаг GoNextAfterMove</short>
|
||
<category>Настройки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.ExportAttachmentsToDocuments(System.Int32,System.String)">
|
||
<summary>Экспорт всех вложений сообщения в "Мои документы"</summary>
|
||
<param name="id_message">ИД любого сообщения</param>
|
||
<param name="id_folder" optional="true">ИД папки "Документы" (если она пуста, то ИД — @My)</param>
|
||
<returns>Число экспортируемых вложений</returns>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.ExportAttachmentToDocuments(System.Int32,System.String)">
|
||
<summary>Экспорт вложения в "Мои документы"</summary>
|
||
<param name="id_attachment">ИД любого вложения из сообщения</param>
|
||
<param name="id_folder" optional="true">ИД папки "Документы" (если она пуста, то ИД — @My)</param>
|
||
<returns>Документ с ИД в "Моих документах"</returns>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.AddAttachment(System.Int32,System.String,System.IO.Stream,System.String)">
|
||
<summary>Добавить вложение в черновик</summary>
|
||
<param name="id_message">ИД любого сообщения</param>
|
||
<param name="name">Имя файла</param>
|
||
<param name="file">Поток файлов</param>
|
||
<param name="content_type">Тип контента файла</param>
|
||
<returns>MailAttachment</returns>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.AddCalendarBody(System.Int32,System.String)">
|
||
<summary>Добавить вложение в черновик</summary>
|
||
<param name="id_message">ИД любого сообщения</param>
|
||
<param name="ical_body">Имя файла</param>
|
||
<returns>MailAttachment</returns>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.UpdateAutoreply(System.Int32,System.Boolean,System.Boolean,System.Boolean,System.DateTime,System.DateTime,System.String,System.String)">
|
||
<summary>Этот метод необходим для обновления или создания автоответа.</summary>
|
||
<param name="mailboxId">ИД обновленного почтового ящика.</param>
|
||
<param name="turnOn">Новый статус автоответа.</param>
|
||
<param name="onlyContacts">Если значение — true, автоответ отправляется только контактам.</param>
|
||
<param name="turnOnToDate">Если значение — true, активно поле "Кому".</param>
|
||
<param name="fromDate">Начальная дата отправки автоответа.</param>
|
||
<param name="toDate">Конечная дата отправки автоответа.</param>
|
||
<param name="subject">Новая тема автоответа.</param>
|
||
<param name="html">Новое значение автоответа.</param>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.#ctor(ASC.Api.Impl.ApiContext)">
|
||
<summary>Конструктор</summary>
|
||
<param name="context"></param>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetMailOperations">
|
||
<summary>Возвращает все операции, выполняемые в Почте (только сложные)</summary>
|
||
<short>Получить все сложные операции, выполняемые в Почте</short>
|
||
<returns>список MailOperationResult</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetMailOperation(System.String)">
|
||
<summary>Возвращает статус сложной операции Почты</summary>
|
||
<short>Получить статус сложной операции Почты</short>
|
||
<param name="operationId">ИД операции</param>
|
||
<returns>MailOperationResult</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.TranslateMailOperationStatus(ASC.Common.Threading.DistributedTask)">
|
||
<summary>Метод перевода статусов почтовых операций</summary>
|
||
<param name="op">экземпляр DistributedTask</param>
|
||
<returns>переведенный текст статуса</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetHelpCenterHtml">
|
||
<summary>Возвращает строку с HTML страницы Справочного центра </summary>
|
||
<returns>Строка с HTML страницы Справочного центра</returns>
|
||
<short>Получить HTML страницы Справочного центра</short>
|
||
<category>HelpCenter</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetSignature(System.Int32)">
|
||
<summary>Этот метод нужен для получения подписи для почтового ящика.</summary>
|
||
<param name="mailbox_id"></param>
|
||
<returns>Объект подписи</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.UpdateSignature(System.Int32,System.String,System.Boolean)">
|
||
<summary>Этот метод нужен для обновления или создания подписи.</summary>
|
||
<param name="mailbox_id">ИД обновленного почтового ящика.</param>
|
||
<param name="html">Новое значение подписи.</param>
|
||
<param name="is_active">Новый статус подписи.</param>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.CreateSampleMessage(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.Boolean,System.Boolean,System.String,System.String)">
|
||
<summary>Создать пример сообщения [Тесты]</summary>
|
||
<param name="folderId"></param>
|
||
<param name="mailboxId"></param>
|
||
<param name="to"></param>
|
||
<param name="cc"></param>
|
||
<param name="bcc"></param>
|
||
<param name="importance"></param>
|
||
<param name="unread"></param>
|
||
<param name="subject"></param>
|
||
<param name="body"></param>
|
||
<returns>ИД сообщения</returns>
|
||
<category>Тесты</category>
|
||
<visible>false</visible>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.AppendAttachmentsToSampleMessage(System.Nullable{System.Int32},System.String,System.IO.Stream,System.String)">
|
||
<summary>Добавить вложение в пример сообщения [Тесты]</summary>
|
||
<param name="messageId">ИД любого сообщения</param>
|
||
<param name="filename">Имя файла</param>
|
||
<param name="stream">Поток файлов</param>
|
||
<param name="contentType">Тип контента файла</param>
|
||
<returns>ИД сообщения</returns>
|
||
<category>Тесты</category>
|
||
<visible>false</visible>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.LoadSampleMessage(System.Nullable{System.Int32},System.Nullable{System.UInt32},System.Nullable{System.Int32},System.Boolean,System.IO.Stream)">
|
||
<summary>Загрузить пример сообщения из EML [Тесты]</summary>
|
||
<param name="folderId"></param>
|
||
<param name="userFolderId"></param>
|
||
<param name="mailboxId"></param>
|
||
<param name="unread"></param>
|
||
<param name="emlStream"></param>
|
||
<returns>ИД сообщения</returns>
|
||
<category>Тесты</category>
|
||
<visible>false</visible>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetAccounts(System.String)">
|
||
<summary>Возвращает список всех почтовых ящиков, псевдонимов и групп для пользователя.</summary>
|
||
<param name="username" visible="false">ИД пользователя</param>
|
||
<returns>Список почтовых ящиков, псевдонимов и групп</returns>
|
||
<short>Получить список почтовых ящиков, псевдонимов и групп</short>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetAccount(System.String)">
|
||
<summary>Возвращает сведения об учетной записи.</summary>
|
||
<param name="email">Адрес электронной почты учетной записи</param>
|
||
<returns>Учетная запись с указанным адресом электронной почты</returns>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
<exception cref="T:System.NullReferenceException">Когда не удается найти почтовый ящик по адресу электронной почты, происходит исключение.</exception>
|
||
<short>Получить учетную запись по адресу эл. почты</short>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.CreateAccountSimple(System.String,System.String)">
|
||
<summary>Создает учетную запись исходя из адреса электронной почты и пароля.</summary>
|
||
<param name="email">Адрес учетной записи в формате строки (например: imya@domen)</param>
|
||
<param name="password">Пароль в виде обычного текста.</param>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
<exception cref="T:System.Exception">Исключение содержит текстовое описание произошедшей ошибки.</exception>
|
||
<returns>Созданная учетная запись</returns>
|
||
<short>Создать новую учетную запись, указав адрес эл. почты и пароль</short>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.CreateAccount(System.String,System.String,System.String,System.String,System.Int32,System.String,System.String,System.String,System.Int32,System.String,System.Boolean,System.Boolean,System.Boolean,ASC.Mail.Enums.EncryptionType,ASC.Mail.Enums.EncryptionType,ASC.Mail.Enums.SaslMechanism,ASC.Mail.Enums.SaslMechanism)">
|
||
<summary>Создает учетную запись на основе всех сведений о почтовых серверах.</summary>
|
||
<param name="name">Название учетной записи на портале</param>
|
||
<param name="email">Адрес учетной записи в формате строки (например: imya@domen).</param>
|
||
<param name="account">Логин для сервера IMAP или POP.</param>
|
||
<param name="password">Пароль для сервера IMAP или POP</param>
|
||
<param name="port">Порт для сервера IMAP или POP</param>
|
||
<param name="server">Адрес или IP-адрес сервера IMAP или POP.</param>
|
||
<param name="smtp_account">Логин для сервера SMTP</param>
|
||
<param name="smtp_password">Пароль для сервера SMTP</param>
|
||
<param name="smtp_port">Порт сервера SMTP</param>
|
||
<param name="smtp_server">Адрес или IP-адрес сервера SMTP.</param>
|
||
<param name="smtp_auth">Флаг, определяющий необходимость аутентификации сервера SMTP. Значение: true или false.</param>
|
||
<param name="imap">Флаг, определяющий необходимость использования сервера IMAP для входящей почты. Значение: true или false.</param>
|
||
<param name="restrict">Флаг, определяющий необходимость загрузки всех сообщений. Значение: true или false. Если значение — true, будут загружаться только сообщения за последние 30 дней.</param>
|
||
<param name="incoming_encryption_type">Укажите тип шифрования для сервера IMAP или POP. 0 — нет, 1 — SSL, 2 — StartTLS</param>
|
||
<param name="outcoming_encryption_type">Укажите тип шифрования для сервера SMTP. 0 — нет, 1 — SSL, 2 — StartTLS</param>
|
||
<param name="auth_type_in">Укажите тип аутентификации для сервера IMAP или POP. 1 — логин, 4 — CremdMd5, 5 — OAuth2</param>
|
||
<param name="auth_type_smtp">Укажите тип аутентификации для сервера IMAP или POP. 0 — нет, 1 — логин, 4 — CremdMd5, 5 — OAuth2</param>
|
||
<returns>Созданная учетная запись</returns>
|
||
<exception cref="T:System.Exception">Исключение содержит текстовое описание произошедшей ошибки.</exception>
|
||
<short>Создать учетную запись с настраиваемыми почтовыми серверами.</short>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.CreateAccountOAuth(System.String,System.Byte)">
|
||
<summary>Создает учетную запись почты с аутентификацией OAuth. Поддерживается только Google OAuth.</summary>
|
||
<param name="code">Код Oauth</param>
|
||
<param name="type">Тип службы OAuth. 0 — неизвестный, 1 — Google.</param>
|
||
<exception cref="T:System.Exception">Исключение содержит текстовое описание произошедшей ошибки.</exception>
|
||
<returns>Созданная учетная запись</returns>
|
||
<short>Создать учетную запись OAuth</short>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.UpdateAccountOAuth(System.String,System.Byte,System.Int32)">
|
||
<summary>Обновить учетную запись Почты с аутентификацией OAuth. Поддерживается только Google OAuth.</summary>
|
||
<param name="code">Код Oauth</param>
|
||
<param name="type">Тип службы OAuth. 0 — неизвестный, 1 — Google.</param>
|
||
<param name="mailboxId">ИД обновляемого почтового ящика</param>
|
||
<exception cref="T:System.Exception">Исключение содержит текстовое описание произошедшей ошибки.</exception>
|
||
<returns>Обновленная учетная запись OAuth</returns>
|
||
<short>Обновить учетную запись OAuth</short>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.UpdateAccount(System.String,System.String,System.String,System.String,System.Int32,System.String,System.String,System.String,System.Int32,System.String,System.Boolean,System.Boolean,ASC.Mail.Enums.EncryptionType,ASC.Mail.Enums.EncryptionType,ASC.Mail.Enums.SaslMechanism,ASC.Mail.Enums.SaslMechanism)">
|
||
<summary>Обновляет существующую учетную запись.</summary>
|
||
<param name="name">Название учетной записи</param>
|
||
<param name="email">Адрес учетной записи в формате строки (например: imya@domen).</param>
|
||
<param name="account">Логин для сервера IMAP или POP.</param>
|
||
<param name="password">Пароль для сервера IMAP или POP</param>
|
||
<param name="port">Порт для сервера IMAP или POP</param>
|
||
<param name="server">Адрес или IP-адрес сервера IMAP или POP.</param>
|
||
<param name="smtp_account">Логин для сервера SMTP</param>
|
||
<param name="smtp_password">Пароль для сервера SMTP</param>
|
||
<param name="smtp_port">Порт сервера SMTP</param>
|
||
<param name="smtp_server">Адрес или IP-адрес сервера SMTP.</param>
|
||
<param name="smtp_auth">Флаг, определяющий необходимость аутентификации сервера SMTP. Значение: true или false.</param>
|
||
<param name="restrict">Флаг, определяющий необходимость загрузки всех сообщений. Значение: true или false. Если значение — true, будут загружаться только сообщения за последние 30 дней.</param>
|
||
<param name="incoming_encryption_type">Укажите тип шифрования для сервера IMAP или POP. 0 — нет, 1 — SSL, 2 — StartTLS</param>
|
||
<param name="outcoming_encryption_type">Укажите тип шифрования для сервера SMTP. 0 — нет, 1 — SSL, 2 — StartTLS</param>
|
||
<param name="auth_type_in">Укажите тип аутентификации для сервера IMAP или POP. 1 — логин, 4 — CremdMd5, 5 — OAuth2</param>
|
||
<param name="auth_type_smtp">Укажите тип аутентификации для сервера IMAP или POP. 0 — нет, 1 — логин, 4 — CremdMd5, 5 — OAuth2</param>
|
||
<returns>Обновленная учетная запись</returns>
|
||
<exception cref="T:System.Exception">Исключение содержит текстовое описание произошедшей ошибки.</exception>
|
||
<short>Обновить учетную запись</short>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.DeleteAccount(System.String)">
|
||
<summary>Удаляет учетную запись с определенным адресом.</summary>
|
||
<param name="email">Отправить по электронной почте сведения об удаляемой учетной записи</param>
|
||
<returns>Объект MailOperationResult</returns>
|
||
<exception cref="T:System.ArgumentException">Когда некоторые параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
<exception cref="T:System.NullReferenceException">Когда почтовый ящик не удается найти, происходит исключение.</exception>
|
||
<short>Удалить учетную запись</short>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SetAccountEnable(System.String,System.Boolean)">
|
||
<summary>Задает состояние указанной в запросе учетной записи</summary>
|
||
<param name="email">Адрес учетной записи</param>
|
||
<param name="state">Состояние активности учетной записи. Значение: true или false. True — включена, False — выключена.</param>
|
||
<returns>ИД почтового ящика учетной записи</returns>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
<exception cref="T:System.Exception">Когда не удается выполнить операцию обновления, происходит исключение.</exception>
|
||
<short>Задать состояние учетной записи</short>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SetDefaultAccount(System.String,System.Boolean)">
|
||
<summary>Задает указанную в запросе учетную запись по умолчанию</summary>
|
||
<param name="email">Адрес учетной записи</param>
|
||
<param name="isDefault">Выбрать учетную запись в качестве учетной записи по умолчанию или выполнить сброс</param>
|
||
<returns>Адрес электронной почты учетной записи</returns>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
<exception cref="T:System.Exception">Когда не удается выполнить операцию обновления, происходит исключение.</exception>
|
||
<short>Задать учетную запись по умолчанию</short>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetAccountDefaults(System.String,System.String)">
|
||
<summary>Получает настройки по умолчанию для учетной записи на основе домена электронной почты.</summary>
|
||
<param name="email">Адрес электронной почты учетной записи</param>
|
||
<param name="action">Этот строковый параметр указывает на действие для настроек по умолчанию. Значения: "get_imap_pop_settings" — получить настройки IMAP или POP, сначала выполняется получение настроек IMAP. "get_imap_server" | "get_imap_server_full" — получить настройки IMAP "get_pop_server" | "get_pop_server_full" — получить настройки POP По умолчанию возвращаются настройки IMAP по умолчанию.</param>
|
||
<returns>Учетная запись с настройками по умолчанию</returns>
|
||
<short>Получить настройки по умолчанию для учетной записи</short>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SetAccountEMailInFolder(System.Int32,System.String)">
|
||
<summary>Задает состояние указанной в запросе учетной записи</summary>
|
||
<param name="mailbox_id">ИД учетной записи</param>
|
||
<param name="email_in_folder">ИД папки документа</param>
|
||
<returns>Адрес электронной почты учетной записи</returns>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
<exception cref="T:System.Exception">Когда не удается выполнить операцию обновления, происходит исключение.</exception>
|
||
<short>Задать состояние учетной записи</short>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.UpdateUserActivity(System.Boolean)">
|
||
<summary>UpdateUserActivity</summary>
|
||
<param name="userOnline"></param>
|
||
<category>Учетные записи</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetAlerts">
|
||
<summary>Возвращает список предупреждений для выполнившего аутентификацию пользователя</summary>
|
||
<returns>Список предупреждений</returns>
|
||
<short>Получить список предупреждений</short>
|
||
<category>Предупреждения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.DeleteAlert(System.Int64)">
|
||
<summary>Удаляет предупреждение с указанным в запросе ИД</summary>
|
||
<param name="id">ИД предупреждения</param>
|
||
<returns>Удаленный ИД предупреждения, который аналогичен параметру запроса.</returns>
|
||
<short>Удалить предупреждение по ИД</short>
|
||
<category>Предупреждения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SearchEmails(System.String)">
|
||
<summary>Возвращает список контактов для функции автозаполнения.</summary>
|
||
<param name="term">строковая часть с именем и фамилией контакта или его адресом электронной почты.</param>
|
||
<returns>Список строк. Формат строк: Сообщение с именем и фамилией</returns>
|
||
<short>Получить список контактов для автозаполнения</short>
|
||
<category>Контакты</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetContacts(System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.Int32,System.String)">
|
||
<summary>Возвращает список почтовых контактов.</summary>
|
||
<param optional="true" name="search">Текст, поиск которого выполняется среди имен и сообщений контактов.</param>
|
||
<param optional="true" name="contactType">Тип контактов</param>
|
||
<param optional="true" name="pageSize">Число контактов на странице</param>
|
||
<param optional="true" name="fromIndex">Номер страницы</param>
|
||
<param name="sortorder">Порядок сортировки по имени. Строковый параметр: "ascending" — по возрастанию, "descending" — по убыванию.</param>
|
||
<returns>Список отфильтрованных контактов</returns>
|
||
<short>Получить отфильтрованные контакты</short>
|
||
<category>Контакты</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetContactsByContactInfo(ASC.Mail.Enums.ContactInfoType,System.String,System.Nullable{System.Boolean})">
|
||
<summary>Возвращает список почтовых контактов со сведениями о контактах</summary>
|
||
<param optional="false" name="infoType">infoType</param>
|
||
<param optional="false" name="data">данные</param>
|
||
<param optional="true" name="isPrimary">isPrimary</param>
|
||
<returns>Список отфильтрованных контактов</returns>
|
||
<short>Получить отфильтрованные контакты</short>
|
||
<category>Контакты</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.CreateContact(System.String,System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String})">
|
||
<summary>Создать почтовый контакт</summary>
|
||
<param name="name">Имя контакта</param>
|
||
<param name="description">Описание контакта</param>
|
||
<param name="emails">Список сообщений</param>
|
||
<param name="phoneNumbers">Список телефонных номеров</param>
|
||
<returns>Информация о созданном контакте</returns>
|
||
<short>Создать почтовый контакт</short>
|
||
<category>Контакты</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.RemoveContacts(System.Collections.Generic.List{System.Int32})">
|
||
<summary>Удаляет выбранные почтовые контакты</summary>
|
||
<param name="ids">Список ИД почтовых контактов</param>
|
||
<returns>Список ИД удаленных почтовых контактов</returns>
|
||
<short>Удалить почтовый контакт</short>
|
||
<category>Контакты</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.UpdateContact(System.Int32,System.String,System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String})">
|
||
<summary>Обновляет существующий почтовый контакт</summary>
|
||
<param name="id">ИД почтового контакта</param>
|
||
<param name="name">Имя контакта</param>
|
||
<param name="description">Описание контакта</param>
|
||
<param name="emails">Список сообщений</param>
|
||
<param name="phoneNumbers">Список телефонных номеров</param>
|
||
<returns>Информация об обновленном контакте</returns>
|
||
<short>Обновить почтовый контакт</short>
|
||
<category>Контакты</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetLinkedCrmEntitiesInfo(System.Int32)">
|
||
<summary>Возвращает список связанных с цепочкой писем сущностей CRM. Сущность: контакт, мероприятие или возможная сделка.</summary>
|
||
<param name="message_id">ИД включенного в цепочку сообщения. Это может быть ИД любого сообщения, входящего в состав цепочки.</param>
|
||
<returns>Список структур: {entity_id, entity_type, avatar_link, title}</returns>
|
||
<short>Получить связанные сущности CRM</short>
|
||
<category>Контакты</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetFilteredConversations(System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean},System.String,System.String,System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Nullable{System.Int32},System.String,ASC.Specific.ApiDateTime,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int32})">
|
||
<summary>Возвращает отфильтрованные цепочки писем, если с момента даты последней проверки произошли изменения</summary>
|
||
<param optional="true" name="folder">ИД папки — целое число. 1 — "Входящие", 2 — "Отправленные", 3 — "Черновики", 4 — "Корзина", 5 — "Спам".</param>
|
||
<param optional="true" name="unread">Статус непрочитанного сообщения. Флаг логического значения. Поиск среди непрочитанных (true), прочитанных (false) или всех (пустое значение) сообщений.</param>
|
||
<param optional="true" name="attachments">Статус вложений сообщения. Флаг логического значения. Поиск сообщений с вложениями (true), без вложений (false) или всех сообщений (пустое значение).</param>
|
||
<param optional="true" name="period_from">Начальная дата периода поиска</param>
|
||
<param optional="true" name="period_to">Конечная дата периода поиска</param>
|
||
<param optional="true" name="important">У сообщения есть флаг важности. Флаг логического значения.</param>
|
||
<param optional="true" name="from_address">Адрес для поиска поля "От кого"</param>
|
||
<param optional="true" name="to_address">Адрес для поиска поля "Кому"</param>
|
||
<param optional="true" name="mailbox_id">ИД почтового ящика получателя.</param>
|
||
<param optional="true" name="tags">Теги сообщений. ИД тегов, связанных в целевыми сообщениями.</param>
|
||
<param optional="true" name="search">Текст для поиска в теле и теме сообщений.</param>
|
||
<param optional="true" name="page_size">Число сообщений на странице</param>
|
||
<param name="sortorder">Порядок сортировки по дате. Строковый параметр: "ascending" — по возрастанию, "descending" — по убыванию.</param>
|
||
<param optional="true" name="from_date">Дата, начиная с которой выполняется поиск цепочек писем</param>
|
||
<param optional="true" name="from_message">Сообщение, с которого начинается поиск цепочек писем</param>
|
||
<param optional="true" name="with_calendar">У сообщения есть флаг календаря. Флаг логического значения.</param>
|
||
<param optional="true" name="user_folder_id">ИД папки пользователя</param>
|
||
<param name="prev_flag"></param>
|
||
<returns>Список отфильтрованных цепочек</returns>
|
||
<short>Получает отфильтрованные цепочки писем</short>
|
||
<category>Цепочки писем</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetConversation(System.Int32,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
|
||
<summary>Получить список сообщений, соединенных в одну цепочку (цепочку писем)</summary>
|
||
<param name="id">ИД любого сообщения в цепочке</param>
|
||
<param name="loadAll">Загрузить контент всех сообщений</param>
|
||
<param optional="true" name="markRead">Пометить цепочку писем как прочитанную</param>
|
||
<param optional="true" name="needSanitize">Флаг указывает на то, что нужно подготовить HTML для FCKeditor</param>
|
||
<returns>Перечислить сообщения, соединенные в одну цепочку</returns>
|
||
<category>Цепочки писем</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetPrevNextConversationId(System.Int32,System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean},System.String,System.String,System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.Nullable{System.Int32})">
|
||
<summary>Получить ИД предыдущей или следующей цепочки писем.</summary>
|
||
<param name="id">ИД первого сообщения текущей цепочки писем.</param>
|
||
<param name="direction">Требуется строковый параметр для определения предыдущей или следующей цепочки писем. "prev" означает "предыдущий", а "next" — "следующий".</param>
|
||
<param optional="true" name="folder">ИД папки — целое число. 1 — "Входящие", 2 — "Отправленные", 5 — "Спам".</param>
|
||
<param optional="true" name="unread">Статус непрочитанного сообщения. Флаг логического значения. Поиск среди непрочитанных (true), прочитанных (false) или всех (пустое значение) сообщений.</param>
|
||
<param optional="true" name="attachments">Статус вложений сообщения. Флаг логического значения. Поиск сообщений с вложениями (true), без вложений (false) или всех сообщений (пустое значение).</param>
|
||
<param optional="true" name="period_from">Начальная дата периода поиска</param>
|
||
<param optional="true" name="period_to">Конечная дата периода поиска</param>
|
||
<param optional="true" name="important">У сообщения есть флаг важности. Флаг логического значения.</param>
|
||
<param optional="true" name="from_address">Адрес для поиска поля "От кого"</param>
|
||
<param optional="true" name="to_address">Адрес для поиска поля "Кому"</param>
|
||
<param optional="true" name="mailbox_id">ИД почтового ящика получателя.</param>
|
||
<param optional="true" name="tags">Теги сообщений. ИД тегов, связанных в целевыми сообщениями.</param>
|
||
<param optional="true" name="search">Текст для поиска в теле и теме сообщений.</param>
|
||
<param optional="true" name="page_size">Число сообщений на странице</param>
|
||
<param name="sortorder">Порядок сортировки по дате. Строковый параметр: "ascending" — по возрастанию, "descending" — по убыванию.</param>
|
||
<param optional="true" name="with_calendar">У сообщения есть флаг with_calendar. Флаг логического значения.</param>
|
||
<param optional="true" name="user_folder_id">ИД папки пользователя</param>
|
||
<returns>ИД первого сообщения предыдущей или следующей цепочки писем.</returns>
|
||
<category>Цепочки писем</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.MoveConversations(System.Collections.Generic.List{System.Int32},System.Int32,System.Nullable{System.UInt32})">
|
||
<summary>Перемещает в папку указанную в ИД цепочку писем.</summary>
|
||
<param name="ids">Список ИД сообщений из цепочек писем.</param>
|
||
<param name="folder">ИД папки — целое число. 1 — "Входящие", 2 — "Отправленные", 3 — "Черновики", 4 — "Корзина", 5 — "Спам".</param>
|
||
<param optional="true" name="userFolderId">ИД папки пользователя</param>
|
||
<returns>Список ИД сообщений из цепочек писем.</returns>
|
||
<short>Переместить цепочки писем в папку</short>
|
||
<category>Цепочки писем</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.RestoreConversations(System.Collections.Generic.List{System.Int32},System.Boolean)">
|
||
<summary>Восстанавливает в исходных папках все цепочки писем, перемещенные ранее в определенные папки.</summary>
|
||
<param name="ids">Список ИД восстанавливаемых цепочек писем.</param>
|
||
<param optional="true" name="learnSpamTrainer">отправить сообщения для обучения отсеиванию спама</param>
|
||
<returns>Список ИД восстановленных цепочек писем</returns>
|
||
<short>Восстановить цепочки писем в исходных папках</short>
|
||
<category>Цепочки писем</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.RemoveConversations(System.Collections.Generic.List{System.Int32})">
|
||
<summary>Удаляет из папок цепочки писем</summary>
|
||
<param name="ids">Список ИД удаляемых цепочек писем.</param>
|
||
<returns>Список ИД удаляемых цепочек писем</returns>
|
||
<short>Удалить цепочки писем</short>
|
||
<category>Цепочки писем</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.MarkConversations(System.Collections.Generic.List{System.Int32},System.String)">
|
||
<summary>Задать статус цепочек писем, указанных ИД.</summary>
|
||
<param name="ids">Список ИД цепочек писем для изменения статуса.</param>
|
||
<param name="status">Строковый параметр указывает на изменяемый статус. Значения: "прочитанные", "непрочитанные", "важные" и "обычные"</param>
|
||
<returns>Список цепочек писем с измененным статусом.</returns>
|
||
<short>Задать статус цепочек писем</short>
|
||
<category>Цепочки писем</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SetConversationsTag(System.Int32,System.Collections.Generic.List{System.Int32})">
|
||
<summary>Добавить в цепочку писем указанный тег.</summary>
|
||
<param name="tag_id">ИД добавляемого тега.</param>
|
||
<param name="messages">Список ИД цепочек писем для добавления тега.</param>
|
||
<returns>Добавлен tag_id</returns>
|
||
<short>Добавить тег в цепочки писем</short>
|
||
<category>Цепочки писем</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.UnsetConversationsTag(System.Int32,System.Collections.Generic.List{System.Int32})">
|
||
<summary>Удаляет из цепочек писем указанный тег.</summary>
|
||
<param name="tag_id">ИД удаляемого тега.</param>
|
||
<param name="messages">Список ИД цепочек писем для удаления тега.</param>
|
||
<returns>Удалён tag_id</returns>
|
||
<short>Удалить тег из цепочек писем</short>
|
||
<category>Цепочки писем</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.LinkConversationToCrm(System.Int32,System.Collections.Generic.IEnumerable{ASC.Mail.Data.Contracts.CrmContactData})">
|
||
<summary>Помечает связь цепочки писем с CRM. Вся новая почта будет добавляться в историю CRM.</summary>
|
||
<param name="id_message">ИД любого сообщения из цепочки</param>
|
||
<param name="crm_contact_ids">Список CrmContactEntity. Формат элемента списка: {entity_id: 0, entity_type: 0}. Типы сущностей: 1 — контакт, 2 — мероприятие, 3 — возможная сделка.</param>
|
||
<returns>нет</returns>
|
||
<category>Цепочки писем</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.MarkConversationAsCrmLinked(System.Int32,System.Collections.Generic.IEnumerable{ASC.Mail.Data.Contracts.CrmContactData})">
|
||
<summary>Помечает связь цепочки писем с CRM. Вся новая почта будет добавляться в историю CRM.</summary>
|
||
<param name="id_message">ИД любого сообщения из цепочки</param>
|
||
<param name="crm_contact_ids">Список CrmContactEntity. Формат элемента списка: {entity_id: 0, entity_type: 0}. Типы сущностей: 1 — контакт, 2 — мероприятие, 3 — возможная сделка.</param>
|
||
<returns>нет</returns>
|
||
<category>Цепочки писем</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.UnmarkConversationAsCrmLinked(System.Int32,System.Collections.Generic.IEnumerable{ASC.Mail.Data.Contracts.CrmContactData})">
|
||
<summary>Метод разрывает связь цепочки писем с CRM.</summary>
|
||
<param name="id_message">ИД любого сообщения из цепочки</param>
|
||
<param name="crm_contact_ids">Список CrmContactEntity. Формат элемента списка: {entity_id: 0, entity_type: 0}. Типы сущностей: 1 — контакт, 2 — мероприятие, 3 — возможная сделка.</param>
|
||
<returns>нет</returns>
|
||
<category>Цепочки писем</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.IsConversationLinkedWithCrm(System.Int32)">
|
||
<summary>Метод проверяет, связана ли цепочка с CRM с помощью message_id.</summary>
|
||
<param name="message_id">ИД любого сообщения из цепочки</param>
|
||
<returns>MailCrmStatus</returns>
|
||
<category>Цепочки писем</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetFolders">
|
||
<summary>Возвращает список папок по умолчанию</summary>
|
||
<returns>Список папок</returns>
|
||
<short>Получить папки</short>
|
||
<category>Папки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.RemoveFolderMessages(System.Int32)">
|
||
<summary>Удаляет все сообщения из папки. "Корзина" или "Спам".</summary>
|
||
<param name="folderid">ИД выбранной папки. "Корзина" — 4, "Спам" — 5.</param>
|
||
<short>Удалить все сообщения из папки</short>
|
||
<category>Папки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.RecalculateFolders">
|
||
<summary>Выполнить пересчет счетчиков папок</summary>
|
||
<returns>Объект MailOperationResult</returns>
|
||
<short>Получить папки</short>
|
||
<category>Папки</category>
|
||
<visible>false</visible>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetUserFolders(System.Collections.Generic.List{System.UInt32},System.Nullable{System.UInt32})">
|
||
<summary>Возвращает список папок пользователя</summary>
|
||
<param name="ids" optional="true">Список ИД папок</param>
|
||
<param name="parentId" optional="true">ИД выбранной родительской папки (корневой уровень равен 0)</param>
|
||
<returns>Список папок</returns>
|
||
<short>Получить папки</short>
|
||
<category>Папки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.CreateUserFolder(System.String,System.UInt32)">
|
||
<summary>Создать папку пользователя</summary>
|
||
<param name="name">Имя папки</param>
|
||
<param name="parentId">ИД родительской папки (по умолчанию он равен 0)</param>
|
||
<returns>Список папок</returns>
|
||
<short>Создание папки</short>
|
||
<category>Папки</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.UpdateUserFolder(System.UInt32,System.String,System.Nullable{System.UInt32})">
|
||
<summary>Обновить папку пользователя</summary>
|
||
<param name="id">ИД папки</param>
|
||
<param name="name">новое имя папки</param>
|
||
<param name="parentId">новый ИД родительской папки (по умолчанию он равен 0)</param>
|
||
<returns>Список папок</returns>
|
||
<short>Обновить папку</short>
|
||
<category>Папки</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.DeleteUserFolder(System.UInt32)">
|
||
<summary>Удалить папку пользователя</summary>
|
||
<param name="id">ИД папки</param>
|
||
<short>Удалить папку</short>
|
||
<category>Папки</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
<returns>Объект MailOperationResult</returns>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetUserFolderByMailId(System.UInt32)">
|
||
<summary>Возвращает папки пользователя по ИД сообщения</summary>
|
||
<param name="mailId">Список ИД папок</param>
|
||
<returns>Папка пользователя</returns>
|
||
<short>Получить папку по ИД </short>
|
||
<category>Папки</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetDisplayImagesAddresses">
|
||
<summary>Возвращает список всех доверенных адресов для показа изображения.</summary>
|
||
<returns>Список адресов. Адреса электронной почты в виде строки (imya@domen).</returns>
|
||
<short>Получить доверенные адреса</short>
|
||
<category>Изображения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.AddDisplayImagesAddress(System.String)">
|
||
<summary>Добавить адрес в список доверенных адресов.</summary>
|
||
<param name="address">Добавляемый адрес.</param>
|
||
<returns>Добавленный адрес</returns>
|
||
<short>Добавить доверенный адрес</short>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
<category>Изображения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.RemovevDisplayImagesAddress(System.String)">
|
||
<summary>Удалить адрес из списка доверенных адресов.</summary>
|
||
<param name="address">Удаляемый адрес</param>
|
||
<returns>Удаленный адрес</returns>
|
||
<short>Удалить из списка доверенных адресов</short>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
<category>Изображения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetFilteredMessages(System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean},System.String,System.String,System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Nullable{System.Int32},System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.Nullable{System.Int32})">
|
||
<summary>Возвращает отфильтрованные сообщения, если с момента даты последней проверки вносились изменения</summary>
|
||
<param optional="true" name="folder">ИД папки</param>
|
||
<param optional="true" name="unread">Статус непрочитанного сообщения</param>
|
||
<param optional="true" name="attachments">Статус сообщения с вложениями</param>
|
||
<param optional="true" name="period_from">Начальная дата периода</param>
|
||
<param optional="true" name="period_to">Конечная дата периода</param>
|
||
<param optional="true" name="important">Сообщение с флагом важности</param>
|
||
<param optional="true" name="from_address">Адрес для поиска поля "От кого"</param>
|
||
<param optional="true" name="to_address">Адрес для поиска поля "Кому"</param>
|
||
<param optional="true" name="mailbox_id">ИД почтового ящика получателя</param>
|
||
<param optional="true" name="tags">Теги сообщения</param>
|
||
<param optional="true" name="search">Текст для поиска в сообщениях</param>
|
||
<param optional="true" name="page">Номер страницы</param>
|
||
<param optional="true" name="with_calendar">У сообщения есть флаг календаря. Флаг логического значения.</param>
|
||
<param optional="true" name="page_size">Количество сообщений на странице</param>
|
||
<param optional="true" name="user_folder_id">ИД папки пользователя</param>
|
||
<param name="sortorder">Порядок</param>
|
||
<returns>Список сообщений</returns>
|
||
<short>Получить отфильтрованные сообщения</short>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetMessage(System.Int32,System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Boolean})">
|
||
<summary>Возвращает подробные сведения о сообщении с указанным в запросе ИД</summary>
|
||
<param name="id">ИД сообщения</param>
|
||
<param optional="true" name="loadImages">Разблокировать подозрительный контент или нет</param>
|
||
<param optional="true" name="needSanitize">Флаг указывает на то, что нужно подготовить HTML для FCKeditor</param>
|
||
<param optional="true" name="markRead">Пометить сообщение как прочитанное</param>
|
||
<returns>MailMessageItem</returns>
|
||
<short>Получить сообщение</short>
|
||
<category>Сообщения</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
<exception cref="T:ASC.Api.Exceptions.ItemNotFoundException">Когда не удается найти сообщение с указанным ИД, происходит исключение.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetPrevNextMessageId(System.Int32,System.String,System.Nullable{System.Int32},System.Nullable{System.Boolean},System.Nullable{System.Boolean},System.Nullable{System.Int64},System.Nullable{System.Int64},System.Nullable{System.Boolean},System.String,System.String,System.Nullable{System.Int32},System.Collections.Generic.IEnumerable{System.Int32},System.String,System.Nullable{System.Int32},System.String,System.Nullable{System.Boolean},System.Nullable{System.Int32})">
|
||
<summary>Получить ИД предыдущего или следующего сообщения.</summary>
|
||
<param name="id">ИД первого сообщения текущей цепочки писем.</param>
|
||
<param name="direction">Требуется строковый параметр для определения предыдущей или следующей цепочки писем. "prev" означает "предыдущий", а "next" — "следующий".</param>
|
||
<param optional="true" name="folder">ИД папки — целое число. 1 — "Входящие", 2 — "Отправленные", 5 — "Спам".</param>
|
||
<param optional="true" name="unread">Статус непрочитанного сообщения. Флаг логического значения. Поиск среди непрочитанных (true), прочитанных (false) или всех (пустое значение) сообщений.</param>
|
||
<param optional="true" name="attachments">Статус вложений сообщения. Флаг логического значения. Поиск сообщений с вложениями (true), без вложений (false) или всех сообщений (пустое значение).</param>
|
||
<param optional="true" name="period_from">Начальная дата периода поиска</param>
|
||
<param optional="true" name="period_to">Конечная дата периода поиска</param>
|
||
<param optional="true" name="important">У сообщения есть флаг важности. Флаг логического значения.</param>
|
||
<param optional="true" name="from_address">Адрес для поиска поля "От кого"</param>
|
||
<param optional="true" name="to_address">Адрес для поиска поля "Кому"</param>
|
||
<param optional="true" name="mailbox_id">ИД почтового ящика получателя.</param>
|
||
<param optional="true" name="tags">Теги сообщений. ИД тегов, связанных в целевыми сообщениями.</param>
|
||
<param optional="true" name="search">Текст для поиска в теле и теме сообщений.</param>
|
||
<param optional="true" name="page_size">Число сообщений на странице</param>
|
||
<param optional="true" name="sortorder">Порядок сортировки по дате. Строковый параметр: "ascending" — по возрастанию, "descending" — по убыванию.</param>
|
||
<param optional="true" name="with_calendar">У сообщения есть флаг with_calendar. Флаг логического значения.</param>
|
||
<param optional="true" name="user_folder_id">ИД папки пользователя</param>
|
||
<returns>ИД предыдущего или следующего сообщения</returns>
|
||
<short>Получить ИД предыдущего или следующего сообщения</short>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.DeleteMessageAttachment(System.Int32,System.Int32)">
|
||
<summary>Удаляет выбранное вложение из сообщения с указанным в запросе ИД</summary>
|
||
<param name="messageid">ИД сообщения, вложение которого будет удалено.</param>
|
||
<param name="attachmentid">Указывает ИД удаляемого вложения.</param>
|
||
<returns>ИД сообщения, вложение которого удалено</returns>
|
||
<short>Удалить вложение из сообщения</short>
|
||
<category>Сообщения</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.MarkMessages(System.Collections.Generic.List{System.Int32},System.String)">
|
||
<summary>Задает статус сообщений, указанных с помощью ИД.</summary>
|
||
<param name="ids">Список ИД сообщений для изменения статуса.</param>
|
||
<param name="status">Строковый параметр указывает на изменяемый статус. Значения: "прочитанные", "непрочитанные", "важные" и "обычные"</param>
|
||
<returns>Список сообщений с измененным статусом</returns>
|
||
<short>Задать статус сообщения</short>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.RestoreMessages(System.Collections.Generic.List{System.Int32})">
|
||
<summary>Восстанавливает сообщения в их исходных папках</summary>
|
||
<param name="ids">Список ИД восстанавливаемых цепочек писем.</param>
|
||
<returns>Список ИД восстановленных сообщений</returns>
|
||
<short>Восстановить сообщения в исходные папки</short>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.MoveMessages(System.Collections.Generic.List{System.Int32},System.Int32,System.Nullable{System.UInt32})">
|
||
<summary>Перемещает сообщения в указанную папку</summary>
|
||
<param name="ids">Список ИД сообщений.</param>
|
||
<param name="folder">ИД папки — целое число. 1 — "Входящие", 2 — "Отправленные", 3 — "Черновики", 4 — "Корзина", 5 — "Спам".</param>
|
||
<param optional="true" name="userFolderId">ИД папки пользователя</param>
|
||
<returns>Список ИД перемещенных сообщений.</returns>
|
||
<short>Переместить сообщение в папку</short>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SendMessage(System.Int32,System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.String,System.Boolean,System.String,System.Collections.Generic.List{System.Int32},System.String,System.Collections.Generic.List{ASC.Mail.Data.Contracts.MailAttachmentData},ASC.Files.Core.Security.FileShare,System.String,System.Boolean)">
|
||
<summary>Отправляет сообщение с указанным в запросе ИД</summary>
|
||
<param name="id">ИД сохраняемого сообщения или 0.</param>
|
||
<param name="from">Адрес отправителя. Формат: Имя<imya@domen></param>
|
||
<param name="to">Список адресов получателей. Формат: Имя<imya@domen></param>
|
||
<param name="cc">Список адресов получателей копии. Формат: Имя<imya@domen></param>
|
||
<param name="bcc">Список адресов получателей скрытой копии. Формат: Имя<imya@domen></param>
|
||
<param name="mimeReplyToId">ИД сообщения, на которое отвечают</param>
|
||
<param name="importance">Флаг важности. Значения: true — важное, false — неважное.</param>
|
||
<param name="subject">Тема сообщения</param>
|
||
<param name="tags">Список ИД добавляемых в сообщение тегов</param>
|
||
<param name="body">Тело сообщения в виде строки HTML.</param>
|
||
<param name="attachments">Список вложений, представленный в виде объекта MailAttachment</param>
|
||
<param name="fileLinksShareMode">Режим общего доступа для ссылок на вложенный файл</param>
|
||
<param name="calendarIcs">Событие календаря для отправки в формате iCal</param>
|
||
<param name="isAutoreply">Указать, является ли сообщение автоответом</param>
|
||
<returns>ИД сообщения</returns>
|
||
<short>Отправить сообщение</short>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SaveMessage(System.Int32,System.String,System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.Collections.Generic.List{System.String},System.String,System.Boolean,System.String,System.Collections.Generic.List{System.Int32},System.String,System.Collections.Generic.List{ASC.Mail.Data.Contracts.MailAttachmentData},System.String)">
|
||
<summary>Сохраняет сообщение с указанным в запросе ИД</summary>
|
||
<param name="id">ИД сохраняемого сообщения или 0.</param>
|
||
<param name="from">Адрес отправителя. Формат: Имя<imya@domen></param>
|
||
<param name="to">Список адресов получателей. Формат: Имя<imya@domen></param>
|
||
<param name="cc">Список адресов получателей копии. Формат: Имя<imya@domen></param>
|
||
<param name="bcc">Список адресов получателей скрытой копии. Формат: Имя<imya@domen></param>
|
||
<param name="mimeReplyToId">ИД сообщения, на которое отвечают</param>
|
||
<param name="importance">Флаг важности. Значения: true — важное, false — неважное.</param>
|
||
<param name="subject">Тема сообщения</param>
|
||
<param name="tags">Список ИД добавляемых в сообщение тегов</param>
|
||
<param name="body">Т ело сообщения в виде строки HTML.</param>
|
||
<param name="attachments">Список вложений, представленный в виде объекта MailAttachment</param>
|
||
<param name="calendarIcs">Событие календаря для отправки в формате iCal</param>
|
||
<returns>ИД сохраненного сообщения</returns>
|
||
<short>Сообщение SaveToDraft</short>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.RemoveMessages(System.Collections.Generic.List{System.Int32})">
|
||
<summary>Удаляет выбранные сообщения</summary>
|
||
<param name="ids">Список ИД удаляемых сообщений.</param>
|
||
<returns>Список ИД удаленных сообщений</returns>
|
||
<short>Удалить сообщения</short>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetMessageTemplate">
|
||
<summary>Возвращает шаблон сообщения. Шаблон сообщения — пустое сообщение JSON.</summary>
|
||
<returns>Пустой MailMessageItem</returns>
|
||
<short>Получить шаблон сообщения</short>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.AttachDocument(System.Int32,System.String,System.String)">
|
||
<summary>Вложить документ с портала в указанное сообщение</summary>
|
||
<param name="id">ИД сообщения, к которому добавляется вложение</param>
|
||
<param name="fileId">ИД документа на портале.</param>
|
||
<param name="version">Версия документа на портале</param>
|
||
<returns>Вложенный документ как объект MailAttachment</returns>
|
||
<short>Вложить документ с портала</short>
|
||
<category>Сообщения</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.ExportMessageToCrm(System.Int32,System.Collections.Generic.IEnumerable{ASC.Mail.Data.Contracts.CrmContactData})">
|
||
<summary>Экспортировать почту в историю связей CRM для некоторых сущностей</summary>
|
||
<param name="id_message">ИД любого сообщения из цепочки</param>
|
||
<param name="crm_contact_ids">Список CrmContactEntity. Формат элемента списка: {entity_id: 0, entity_type: 0}. Типы сущностей: 1 — контакт, 2 — мероприятие, 3 — возможная сделка.</param>
|
||
<returns>нет</returns>
|
||
<category>Сообщения</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.GetTags">
|
||
<summary>Возвращает список тегов, используемых в Почте</summary>
|
||
<returns>Список тегов. Теги, представленные в виде JSON.</returns>
|
||
<short>Получить список тегов</short>
|
||
<category>Теги</category>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.CreateTag(System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||
<summary>Создает новый тег</summary>
|
||
<param name="name">Название тега, представленное в виде строки</param>
|
||
<param name="style">Идентификатор стиля. С постфиксом, который будет добавлен к стилю CSS тега, который он будет представлять. Указывает на цвет тега.</param>
|
||
<param name="addresses">Указывает на список адресов, с которым связан тег.</param>
|
||
<returns>MailTag</returns>
|
||
<short>Создать тег</short>
|
||
<category>Теги</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.UpdateTag(System.Int32,System.String,System.String,System.Collections.Generic.IEnumerable{System.String})">
|
||
<summary>Обновляет выбранный тег</summary>
|
||
<param name="id"></param>
|
||
<param name="name">Название тега, представленное в виде строки</param>
|
||
<param name="style">Идентификатор стиля. С постфиксом, который будет добавлен к стилю CSS тега, который он будет представлять. Указывает на цвет тега.</param>
|
||
<param name="addresses">Указывает на список адресов, с которым связан тег.</param>
|
||
<returns>Обновленный MailTag</returns>
|
||
<short>Обновить тег</short>
|
||
<category>Теги</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.DeleteTag(System.Int32)">
|
||
<summary>Удаляет выбранный тег из TLMail</summary>
|
||
<param name="id">Тег для удаления ИД</param>
|
||
<returns>Удаленный MailTag</returns>
|
||
<short>Удалить тег</short>
|
||
<category>Теги</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.SetTag(System.Int32,System.Collections.Generic.List{System.Int32})">
|
||
<summary>Добавляет выбранный тег к сообщениям</summary>
|
||
<param name="id">Тег для ИД настройки</param>
|
||
<param name="messages">ИД сообщений для настройки.</param>
|
||
<returns>Заданный MailTag</returns>
|
||
<short>Задать тег для сообщений</short>
|
||
<category>Теги</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="M:ASC.Api.Mail.MailApi.UnsetTag(System.Int32,System.Collections.Generic.List{System.Int32})">
|
||
<summary>Удаляет указанный тег из сообщений</summary>
|
||
<param name="id">ИД удаляемого тега</param>
|
||
<param name="messages">ИД удаляемых сообщений.</param>
|
||
<returns>Тег удаленной почты</returns>
|
||
<short>Удалить тег из сообщений</short>
|
||
<category>Теги</category>
|
||
<exception cref="T:System.ArgumentException">Когда параметры недопустимы, происходит исключение. Текстовое описание содержит название параметра и описание в виде текста.</exception>
|
||
</member>
|
||
<member name="P:ASC.Api.Mail.MailApi.Name">
|
||
<summary>Запись названия API</summary>
|
||
</member>
|
||
<member name="P:ASC.Api.Mail.MailApi.MailAutocompleteMaxCountPerSystem">
|
||
<summary>Результат ограничения для системы контакта</summary>
|
||
</member>
|
||
<member name="P:ASC.Api.Mail.MailApi.MailAutocompleteTimeout">
|
||
<summary>Таймаут в миллисекундах</summary>
|
||
</member>
|
||
</members>
|
||
</doc> |