helpcenter/helpcenter.r7-office.ru/Web/Bin/ASC.Api.MailServer.XML

<?xml version="1.0" encoding="utf-8"?>
<doc>
    <assembly>
        <name>ASC.Api.MailServer</name>
    </assembly>
    <members>
        <member name="M:ASC.Api.MailServer.MailServerApi.CreateMailbox(System.String,System.String,System.Int32,System.String,System.Boolean,System.Boolean)">
            <summary>Создать почтовый ящик</summary>
            <param name="name"></param>
            <param name="local_part"></param>
            <param name="domain_id"></param>
            <param name="user_id"></param>
            <param name="notifyCurrent">Отправить сообщение по адресу создаваемого почтового ящика</param>
            <param name="notifyProfile">Отправить сообщение по адресу электронной почты из профиля пользователя</param>
            <returns>Параметр MailboxData, связанный с владельцем</returns>
            <short>Создать почтовый ящик</short> 
            <category>Почтовые ящики</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.CreateMyMailbox(System.String)">
            <summary>Создать мой почтовый ящик</summary>
            <param name="name"></param>
            <returns>Параметр MailboxData, связанный с владельцем</returns>
            <short>Создать почтовый ящик</short> 
            <category>Почтовые ящики</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.GetMailboxes">
            <summary>Возвращает список почтовых ящиков, связанных с владельцем</summary>
            <returns>Список параметров MailboxData для текущего владельца</returns>
            <short>Получить список почтовых ящиков</short> 
            <category>Почтовые ящики</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.RemoveMailbox(System.Int32)">
            <summary>Удаляет выбранный почтовый ящик</summary>
            <param name="id">ИД почтового ящика</param>
            <returns>Объект MailOperationResult</returns>
            <exception cref="T:System.ArgumentException">Когда ряд параметров неверен, происходит исключение. Текстовое описание содержит название параметра и текстовое описание.</exception>
            <exception cref="T:ASC.Api.Exceptions.ItemNotFoundException">Когда почтовый ящик не найден, происходит исключение.</exception>
            <short>Удалить почтовый ящик с почтового сервера</short> 
            <category>Почтовые ящики</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.UpdateMailbox(System.Int32,System.String)">
            <summary>Обновить почтовый ящик</summary>
            <param name="mailbox_id">ИД почтового ящика</param>
            <param name="name">имя отправителя</param>
            <returns>Обновленный MailboxData</returns>
            <short>Обновить почтовый ящик</short>
            <category>Почтовые ящики</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.AddMailboxAlias(System.Int32,System.String)">
            <summary>Добавить псевдоним почтового ящика</summary>
            <param name="mailbox_id">ИД почтового ящика</param>
            <param name="alias_name">название псевдонима</param>
            <returns>Параметр MailboxData, связанный с владельцем</returns>
            <short>Добавить псевдонимы почтового ящика</short>
            <category>AddressData</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.RemoveMailboxAlias(System.Int32,System.Int32)">
            <summary>Удалить псевдоним из почтового ящика</summary>
            <param name="mailbox_id">ИД почтового ящика</param>
            <param name="address_id"></param>
            <returns>ИД почтового ящика</returns>
            <short>Удалить псевдонимы почтового ящика</short>
            <category>Почтовые ящики</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.ChangeMailboxPassword(System.Int32,System.String)">
            <summary>Изменить пароль почтового ящика</summary>
            <param name="mailbox_id"></param>
            <param name="password"></param>
            <short>Изменить пароль почтового ящика</short> 
            <category>Почтовые ящики</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.IsAddressAlreadyRegistered(System.String,System.Int32)">
            <summary>Проверка наличия адреса почтового ящика</summary>
            <param name="local_part"></param>
            <param name="domain_id"></param>
            <short>Проверка наличия адреса почтового ящика на сервере</short>
            <returns>&quot;True&quot; означает, что адрес существует, а &quot;False&quot; — не существует</returns>
            <category>Почтовые ящики</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.IsAddressValid(System.String,System.Int32)">
            <summary>Проверить адрес почтового ящика</summary>
            <param name="local_part"></param>
            <param name="domain_id"></param>
            <short>Проверка допустимости адреса почтового ящика на сервере</short>
            <returns>&quot;True&quot; означает, что адрес допустим, а &quot;False&quot; — недопустим</returns>
            <category>Почтовые ящики</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.CreateMailGroup(System.String,System.Int32,System.Collections.Generic.List{System.Int32})">
            <summary>Создать групповой адрес</summary>
            <param name="name"></param>
            <param name="domain_id"></param>
            <param name="address_ids"></param>
            <returns>Параметр MailGroupData, связанный с владельцем</returns>
            <short>Добавить групповой почтовый адрес</short>
            <category>MailGroup</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.AddMailGroupAddress(System.Int32,System.Int32)">
            <summary>Добавить адреса в группу</summary>
            <param name="mailgroup_id">ИД группового адреса</param>
            <param name="address_id"></param>
            <returns>Параметр MailGroupData, связанный с владельцем</returns>
            <short>Добавить адреса группы</short> 
            <category>MailGroup</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.RemoveMailGroupAddress(System.Int32,System.Int32)">
            <summary>Удалить адрес из группы</summary>
            <param name="mailgroup_id">ИД группового адреса</param>
            <param name="address_id"></param>
            <returns>ИД группового адреса</returns>
            <short>Удалить адрес группы</short>
            <category>MailGroup</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.GetMailGroups">
            <summary>Возвращает список адресов групп, связанных с владельцем</summary>
            <returns>Список параметров MailGroupData для текущего владельца</returns>
            <short>Получить список почтовой группы</short>
            <category>MailGroup</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.RemoveMailGroup(System.Int32)">
            <summary>Удаляет выбранный групповой адрес</summary>
            <param name="id">ИД группового адреса</param>
            <returns>ИД группового адреса</returns>
            <short>Удалить групповой адрес с почтового сервера</short> 
            <category>MailGroup</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.CreateNotificationAddress(System.String,System.String,System.Int32)">
            <summary>Создать адрес для уведомлений владельца</summary>
            <param name="name"></param>
            <param name="password"></param>
            <param name="domain_id"></param>
            <returns>Параметр NotificationAddressData, связанный с владельцем</returns>
            <short>Создать адрес для уведомлений</short> 
            <category>Уведомления</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.RemoveNotificationAddress(System.String)">
            <summary>Удалить адрес для уведомлений</summary>
            <short>Удалить почтовый ящик с почтового сервера</short> 
            <category>Уведомления</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.GetMailServer">
            <summary>Возвращает параметр ServerData для почтового сервера, связанного с владельцем</summary>
            <returns>Параметр ServerData для текущего владельца.</returns>
            <short>Узнать почтовый сервер</short> 
            <category>Серверы</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.GetMailServerFullInfo">
            <summary>Возвращает параметр ServerData для почтового сервера, связанного с владельцем</summary>
            <returns>Параметр ServerData для текущего владельца.</returns>
            <short>Узнать почтовый сервер</short> 
            <category>Серверы</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.GetUnusedDnsRecords">
            <summary>Получить или создать записи DNS для бесплатного домена </summary>
            <returns>Записи DNS для текущего владельца и пользователя.</returns>
            <short>Получить бесплатно записи DNS</short>
            <category>DnsRecords</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.GetDomains">
            <summary>Возвращает список веб-доменов, связанных с владельцем</summary>
            <returns>Список параметров WebDomainData для текущего владельца</returns>
            <short>Получить список веб-доменов владельца</short> 
            <category>Домены</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.GetCommonDomain">
            <summary>Возвращает общий веб-домен</summary>
            <returns>WebDomainData для общего веб-домена</returns>
            <short>Узнать общий веб-домен</short> 
            <category>Домены</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.AddDomain(System.String,System.Int32)">
            <summary>Связать веб-домен с владельцем</summary>
            <param name="name">имя веб-домена</param>
            <param name="id_dns"></param>
            <returns>Параметр WebDomainData, связанный с владельцем</returns>
            <short>Добавить домен на почтовом сервере</short> 
            <category>Домены</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.RemoveDomain(System.Int32)">
            <summary>Удаляет выбранный веб-домен</summary>
            <param name="id">ИД веб-домена</param>
            <returns>Объект MailOperationResult</returns>
            <short>Удалить домен с почтового сервера</short> 
            <category>Домены</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.GetDnsRecords(System.Int32)">
            <summary>Возвращает записи DNS, связанные с доменом</summary>
            <param name="id">ИД домена</param>
            <returns>Записи DNS, связанные с доменом</returns>
            <short>Возвращает записи DNS</short>
            <category>DnsRecords</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.IsDomainExists(System.String)">
            <summary>Проверить наличие имени веб-домена</summary>
            <param name="name">имя веб-домена</param>
            <returns>&quot;True&quot; указывает на то, что доменное имя уже существует.</returns>
            <short>Проверка наличия доменного имени.</short> 
            <category>Домены</category>
        </member>
        <member name="M:ASC.Api.MailServer.MailServerApi.CheckDomainOwnership(System.String)">
            <summary>Узнать по текстовой записи в DNS, кому принадлежит имя веб-домена</summary>
            <param name="name">имя веб-домена</param>
            <returns>&quot;True&quot; указывает на то, что пользователь владеет этим доменом.</returns>
            <short>Проверить владельца домена.</short> 
            <category>Домены</category>
        </member>
        <member name="P:ASC.Api.MailServer.MailServerApi.Name">
            <summary>Запись названия API</summary>
        </member>
    </members>
</doc>