API Яндекс Почта для домена + PowerShell: создаём ящики пакетом из .csv файлаВ некоторых предыдущих статьях уже затрагивал Яндекс API сервиса “Почта для домена”. Могу похвастаться тем, что добил таки модуль PowerShell, реализующий командлеты для использования указанного API в PowerShell. И в качестве первой задача – создание произвольного количества ящиков и группы рассылки, состоящей из этих ящиков, на базе данных из .csv файла.


Бочка мёда

Для затравки приведу код сценария, использующего разработанный модуль powershell:

<#
    .Synopsis
        Загружает данные сотрудников из .csv файла, создаёт ящики на припаркованном
        на Яндексе домене
    .Description
        Загружает данные сотрудников из .csv файла, создаёт ящики на припаркованном
        на Яндексе домене
    .Example
        .\UpdateUsersAttributes.ps1 -csvFile 'users.csv'
#> 
[CmdletBinding(
    ConfirmImpact = 'Low',
    SupportsShouldProcess = $true
)]

param (
    # Полный путь к файлу, из которого будем импортировать
    [Parameter(
        Mandatory=$false,
        Position=0,
        ValueFromPipeline=$false
    )]
    [System.IO.FileInfo]
    $csvFile = `
        (join-path `
            -path ( ( [System.IO.FileInfo] ( $myinvocation.mycommand.path ) ).directory ) `
            -childPath 'users.csv' `
        )
) 

Import-Module `
    (join-path `
        -path ( ( [System.IO.FileInfo] ( $myinvocation.mycommand.path ) ).directory ) `
        -childPath 'ITG.PrepareModulesEnv.ps1' `
    ) `
;

Import-Module 'ITG.Yandex.PDD' -Prefix 'Yandex' -ErrorAction Stop;

get-content `
    -path $csvFile `
| convertFrom-csv `
    -UseCulture `
| New-YandexMailbox -DomainName 'csm.nov.ru' -Force -PassThru `
| New-YandexMailList -DomainName 'csm.nov.ru' -MailList 'all' `
;

Как видно, после импорта модуля и прочих заголовков в 6 строк мы загружаем данные о пользователях из .csv файла, создаём для каждого пользователя ящик на припаркованном на Яндекс домене ”csm.nov.ru”, и включаем адрес пользователя в группу рассылки all на том же домене.

Удобно? Самому понравился результат. В дополнение скажу: командлеты поддерживают параметры –verbose, –confirm, –debug, –whatif.

А где же улей?

Целиком проект со всеми зависимостями лучше всего получить с git репозитория – https://github.com/sergey-s-betke/Users. Он содержит submodules, поэтому не забудьте после git clone обновить модули.

Чуть ближе к дёгтю

А теперь к самому модулю ITG.Yandex.PDD. Размещён он так же в git репозитории на github – ITG.Yandex.PDD. Приведу код модуля, хотя он получился огромным.

'ITG.WinAPI.User32' `
, 'ITG.WinAPI.UrlMon' `
, 'ITG.RegExps' `
| Import-Module;

Set-Variable `
    -Name DefaultDomain `
    -Value ([string]'') `
    -Scope Global `
;
Set-Variable `
    -Name DefaultToken `
    -Value ([string]'') `
    -Scope Global `
;

Set-Variable `
    -Name APIRoot `
    -Option Constant `
    -Value 'https://pddimp.yandex.ru' `
;

function Get-Token {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API get_token) предназначен для получения авторизационного токена.
        .Description
            Метод get_token предназначен для получения авторизационного токена.
            Авторизационный токен используется для активации API Яндекс.Почты для доменов. Получать токен
            нужно только один раз. Чтобы получить токен, следует иметь подключенный домен, авторизоваться
            его администратором.
            Синтаксис запроса:
                https://pddimp.yandex.ru/get_token.xml ? domain_name =<имя домена>
            Получение токена для домена yourdomain.ru:

https://pddimp.yandex.ru/get_token.xml?domain_name=yourdomain.ru

            Формат ответа
            Если ошибок нет, метод возвращает <ok token="..."/>, в противном случае - <error reason='...'/>.
            Но данная функция возвращает непосредственно токен, либо генерирует исключение.
        .Outputs
            [System.String] - собственно token
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/get-token.xml#get-token

        .Example
            Получение токена для домена yourdomain.ru:
            $token = Get-Token -DomainName 'yourdomain.ru';
    #>

    [CmdletBinding()]
    
    param (
        # имя домена - любой из доменов, зарегистрированных под Вашей учётной записью на сервисах Яндекса
        [Parameter(
            Mandatory=$true,
            Position=0,
            ValueFromPipeline=$true,
            ValueFromRemainingArguments=$true
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    )

    process {
        $global:DefaultDomain = $DomainName;
        $get_tokenURI = [System.Uri]"$APIRoot/get_token.xml?domain_name=$( [System.Uri]::EscapeDataString( $DomainName ) )";
        $get_tokenAuthURI = [System.Uri]"https://passport.yandex.ru/passport?mode=auth&msg=pdd&retpath=$( [System.Uri]::EscapeDataString( $get_tokenURI ) )";

        try {
            Write-Verbose 'Создаём экземпляр InternetExplorer.';
            $ie = New-Object -Comobject InternetExplorer.application;
            Write-Verbose "Отправляем InternetExplorer на Яндекс.Паспорт ($get_tokenAuthURI).";
            $ie.Navigate( $get_tokenAuthURI );
            $ie.Visible = $True;
            
            $ie `
            | Set-WindowZOrder -ZOrder ( [ITG.WinAPI.User32.HWND]::Top ) -PassThru `
            | Set-WindowForeground -PassThru `
            | Out-Null
            ;

            Write-Verbose 'Ждём либо пока Яндекс.Паспорт сработает по cookies, либо пока администратор авторизуется на Яндекс.Паспорт...';
            while ( `
                $ie.Busy `
                -or (-not ([System.Uri]$ie.LocationURL).IsBaseOf( $get_tokenURI ) ) `
            ) { Sleep -milliseconds 100; };
            $ie.Visible = $False;

            $res = ( $ie.document.documentElement.innerhtml );
            Write-Debug "Ответ API get_token: $($ie.document.documentElement.innerhtml).";
            if ( $res.ok ) {
                $token = [System.String]$res.ok.token;
                Write-Verbose "Получили токен для домена $($DomainName): $token.";
                $token;
                $global:DefaultToken = $token;
            } else {
                $errMsg = $res.error.reason;
                Write-Error `
                    -Message "Ответ API get_token для домена $DomainName отрицательный." `
                    -Category PermissionDenied `
                    -CategoryReason $errMsg `
                    -CategoryActivity 'Yandex.API.get_token' `
                    -CategoryTargetName $DomainName `
                    -RecommendedAction 'Проверьте правильность указания домена и Ваши права на домен.' `
                ;
            };
        } finally {
            Write-Verbose 'Уничтожаем экземпляр InternetExplorer.';
            $ie.Quit(); 
            $res = [System.Runtime.InteropServices.Marshal]::ReleaseComObject( $ie );
        };
    }
};

function Test-Token {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод - проверяет действительность переданного токена (на самом деле - лишь сравнивает с пустой
            строкой, и в случае недействительности запрашивает его через Get-Token.
        .Description
            Метод - проверяет действительность переданного токена (на самом деле - лишь сравнивает с пустой
            строкой, и в случае недействительности запрашивает его через Get-Token.
        .Outputs
            [System.String] - собственно token
        .Link
            Get-Token
        .Example
            $token = Test-Token -DomainName 'yourdomain.ru';
    #>

    [CmdletBinding()]
    
    param (
        # имя домена - любой из доменов, зарегистрированных под Вашей учётной записью на сервисах Яндекса
        [Parameter(
            Position = 0
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет запрошен автоматически
        # через вызов Get-Token
        [Parameter(
            Position = 1
        )]
        [string]
        $Token
    )

    if ( ( $DomainName -eq $DefaultDomain ) -and ( $DefaultToken ) ) {
        $DefaultToken;
    } else {
        Get-Token -DomainName $DomainName;
    };
};

function Invoke-API {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Обёртка для вызовов методов API Яндекс.Почты для доменов.
        .Description
            Обёртка для вызовов методов API Яндекс.Почты для доменов.
        .Outputs
             - Результат, возвращённый API.
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true,
        ConfirmImpact="Medium"
    )]
    
    param (
        # HTTP метод вызова API.
        [Parameter(
            Mandatory=$false
        )]
        [string]
        $HttpMethod = [System.Net.WebRequestMethods+HTTP]::Get
    ,
        # авторизационный токен, полученный через Get-Token.
        [Parameter(
            Mandatory=$true
        )]
        [string]
        $Token
    ,
        # метод API - компонент url.
        [Parameter(
            Mandatory=$true
        )]
        [ValidateNotNullOrEmpty()]
        [string]
        $method
    ,
        # имя домена для регистрации на сервисах Яндекса
        [Parameter(
            Mandatory=$true
        )]
        [ValidateNotNullOrEmpty()]
        [string]
        $DomainName
    ,
        # коллекция параметров метода API
        [AllowEmptyCollection()]
        [System.Collections.IDictionary]
        $Params = @{}
    ,
        # предикат успешного выполнения метода API
        [scriptblock]
        $IsSuccessPredicate = { [bool]$_.action.status.success }
    ,
        # предикат ошибки при выполнении метода API. Если ни один из предикатов не вернёт $true - генерируем неизвестную ошибку
        [scriptblock]
        $IsFailurePredicate = { [bool]$_.action.status.error }
    ,
        # фильтр обработки результата. Если фильтр не задан - функция не возвращает результат.
        [scriptblock]
        $ResultFilter = {}
    ,
        # Шаблон сообщения об успешном выполнении API.
        [string]
        $SuccessMsg = "Метод API $method успешно выполнен для домена $DomainName."
    ,
        # Шаблон сообщения об ошибке вызова API.
        [string]
        $FailureMsg = "Ошибка при вызове метода API $method для домена $DomainName"
    ,
        # Фильтр обработки результата для выделения сообщения об ошибке.
        [scriptblock]
        $FailureMsgFilter = { $_.action.status.error.'#text' }
    ,
        # Шаблон сообщения о недиагностируемой ошибке вызова API.
        [string]
        $UnknownErrorMsg = "Неизвестная ошибка при вызове метода API $method для домена $DomainName."
    )

    $Params.Add( 'token', $Token );
    $Params.Add( 'domain', $DomainName );
    
    switch ( $HttpMethod ) {
        ( [System.Net.WebRequestMethods+HTTP]::Get ) {
            $escapedParams = (
                $Params.keys `
                | % { "$_=$([System.Uri]::EscapeDataString($Params.$_))" } `
            ) -join '&';
            $apiURI = [System.Uri]"$APIRoot/$method.xml?$escapedParams";
            $wc = New-Object System.Net.WebClient;
            $WebMethodFunctional = { 
                $wc.DownloadString( $apiURI );
            };
        }
        ( [System.Net.WebRequestMethods+HTTP]::Post ) {
            $apiURI = [System.Uri] ( "$APIRoot/$method.xml" );
            
            $WebMethodFunctional = { 
                $wreq = [System.Net.WebRequest]::Create( $apiURI );
                $wreq.Method = $HttpMethod;
                $boundary = "##params-boundary##";
                $wreq.ContentType = "multipart/form-data; boundary=$boundary";
                $reqStream = $wreq.GetRequestStream();
                $writer = New-Object System.IO.StreamWriter( $reqStream );
                $writer.AutoFlush = $true;
                
                foreach( $param in $Params.keys ) {
                    if ( $Params.$param -is [System.IO.FileInfo] ) {
                           $writer.Write( @"
--$boundary
Content-Disposition: form-data; name="$param"; filename="$($Params.$param.Name)"
Content-Type: $(Get-MIME ($Params.$param))
Content-Transfer-Encoding: binary


"@
                        );
                        $fs = New-Object System.IO.FileStream (
                            $Params.$param.FullName, 
                            [System.IO.FileMode]::Open,
                            [System.IO.FileAccess]::Read,
                            [system.IO.FileShare]::Read
                        );
                        try {
                            $fs.CopyTo( $reqStream );
                        } finally {
                            $fs.Close();
                            $fs.Dispose();
                        };
                        $writer.WriteLine();
                    } else {
                        $writer.Write( @"
--$boundary
Content-Disposition: form-data; name="$param"

$($Params.$param)

"@
                        );
                    };
                };
                $writer.Write( @"
--$boundary--

"@ );
                $writer.Close();
                $reqStream.Close();

                $wres = $wreq.GetResponse();
                $resStream = $wres.GetResponseStream();
                $reader = New-Object System.IO.StreamReader ( $resStream );
                $responseFromServer = [string]( $reader.ReadToEnd() );

                $reader.Close();
                $resStream.Close();
                $wres.Close();                

                $responseFromServer;
            };
        }
    };
    if ( $PSCmdlet.ShouldProcess( $DomainName, "Yandex.API.PDD::$method" ) ) {
        try {
            Write-Verbose "Вызов API $method для домена $($DomainName): $apiURI.";
            $resString = ( [string] ( & $WebMethodFunctional ) );
            Write-Debug "Ответ API $method: $($resString).";
            $res =  $resString;
        
            $_ = $res;
            if ( & $IsSuccessPredicate ) {
                Write-Verbose $SuccessMsg;
                & $ResultFilter;
            } elseif ( & $IsFailurePredicate ) {
                Write-Error `
                    -Message "$FailureMsg - ($( & $FailureMsgFilter ))" `
                    -Category CloseError `
                    -CategoryActivity 'Yandex.API' `
                    -RecommendedAction 'Проверьте правильность указания домена и Ваши права на домен.' `
                ;
            } else { # недиагностируемая ошибка вызова API
                Write-Error `
                    -Message $UnknownErrorMsg `
                    -Category InvalidResult `
                    -CategoryActivity 'Yandex.API' `
                    -RecommendedAction 'Проверьте параметры.' `
                ;
            };
        } catch {
            Write-Error `
                -Message "$UnknownErrorMsg ($($_.Exception.Message))." `
                -Category InvalidOperation `
                -CategoryActivity 'Yandex.API' `
            ;
        };
    };
}  

function Register-Domain {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API reg_domain) предназначен для регистрации домена на сервисах Яндекса.
        .Description
            Метод регистрирует домен на сервисах Яндекса.
            Синтаксис запроса
                https://pddimp.yandex.ru/api/reg_domain.xml ? token =<токен> & domain =<имя домена>
            Если домен уже подключен, то метод reg_domain не выполняет никаких действий, возвращая секретное
            имя и секретную строку.
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_reg_domain.xml

        .Example
            Регистрация нескольких доменов:
            $token = Get-Token -DomainName 'maindomain.ru';
            'domain1.ru', 'domain2.ru' | Register-Domain -Token $token
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true,
        ConfirmImpact="Medium"
    )]
    
    param (
        # имя домена для регистрации на сервисах Яндекса
        [Parameter(
            Mandatory=$true,
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    )

    process {
        Invoke-API `
            -method 'api/reg_domain' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -SuccessMsg "Домен $($DomainName) успешно подключен." `
            -ResultFilter { 
                $_.action.domains.domain `
                | Select-Object -Property `
                    @{Name='DomainName'; Expression={$_.name}}`
                    , @{Name='SecretName'; Expression={$_.secret_name.'#text'}} `
                    , @{Name='SecretValue'; Expression={$_.secret_value.'#text'}} `
            } `
        ;
    }
}  

function Remove-Domain {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API del_domain) предназначен для отключения домена от Яндекс.Почта для доменов.
        .Description
            Метод позволяет отключить домен.
            Отключенный домен перестает выводиться в списке доменов. После отключения домен можно подключить заново.
            Отключение домена не влечет за собой изменения MX-записей. MX-записи нужно устанавливать отдельно на
            DNS-серверах, куда делегирован домен.
            Синтаксис запроса
                https://pddimp.yandex.ru/api/del_domain.xml ? token =<токен> & domain =<имя домена>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_del_domain.xml

        .Example
            $token = Get-Token -DomainName 'maindomain.ru';
            Remove-Domain -DomainName 'test.ru';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true,
        ConfirmImpact="High"
    )]
    
    param (
        # имя домена для регистрации на сервисах Яндекса
        [Parameter(
            Mandatory=$true,
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # передавать домены далее по конвейеру или нет
        [switch]
        $PassThru
    )

    process {
        Invoke-API `
            -method 'api/del_domain' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -SuccessMsg "Домен $($DomainName) успешно отключен." `
        ;
        if ( $PassThru ) { $input };
    }
}  

function Set-DefaultEmail {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API reg_default_user) предназначен для указания ящика,
            который будет получать почту при обнаружении в адресе несуществующего на текущий момент
            в домене lname.
        .Description
            Метод позволяет задать почтовый ящик по умолчанию для домена.
            Ящик по умолчанию - это ящик, в который приходят все письма на домен, адресованные в
            несуществующие на этом домене ящики.
            Синтаксис запроса
                https://pddimp.yandex.ru/api/reg_default_user.xml ? token =<токен> & domain =<домен> & login =<имя ящика>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_reg_default_user.xml

        .Example
            Set-DefaultEmail -DomainName 'csm.nov.ru' -LName 'master';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true,
        ConfirmImpact="Medium"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false,
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # имя почтового ящика. Ящик с именем lname должен уже существовать
        [Parameter(
            Mandatory=$true
            , ValueFromPipelineByPropertyName=$true
            , Position=0
            , ValueFromRemainingArguments=$true
        )]
        [string]
        [ValidateNotNullOrEmpty()]
        [Alias("DefaultEmail")]
        [Alias("default_email")]
        [Alias("login")]
        $LName
    )

    process {
        Invoke-API `
            -method 'api/reg_default_user' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -Params @{
                login = $LName
            } `
            -IsSuccessPredicate { [bool]$_.action.status.'action-status'.get_item('success') } `
            -IsFailurePredicate { [bool]$_.action.status.'action-status'.get_item('error') } `
            -FailureMsgFilter { $_.action.status.'action-status'.error.'#text' } `
            -ResultFilter { 
                $_.action.domains.domain `
                | Select-Object -Property `
                    @{Name='DomainName'; Expression={$_.name}}`
                    , @{Name='DefaultEmail'; Expression={$_.'default-email'}} `
            } `
        ;
    }
}  

function Set-Logo {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API add_logo) предназначен для установки логотипа для домена.
        .Description
            Метод позволяет установить логотип домена.
            Синтаксис запроса

https://pddimp.yandex.ru/api/add_logo.xml

            Метод вызывается только как POST-запрос. Файл, содержащий логотип, и параметры передаются
            как multipart/form-data. Поддерживаются графические файлы форматов jpg, gif, png размером
            до 2 Мбайт. Имя файла и название параметра не важны.
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_add_logo.xml

        .Example
            Установка логотипа для домена yourdomain.ru:
            Set-Logo -DomainName 'yourdomain.ru' -Token $token -Path 'c:\work\logo.png';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true,
        ConfirmImpact="Low"
    )]
    
    param (
        # имя домена - любой из доменов, зарегистрированных под Вашей учётной записью на сервисах Яндекса
        # если явно домен не указан, то будет использован последний домен, указанный при вызовах yandex.api
        [Parameter(
            Mandatory=$false,
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет запрошен автоматически
        # через вызов Get-Token
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # путь к файлу логотипа.
        # Поддерживаются графические файлы форматов jpg, gif, png размером до 2 Мбайт
        [Parameter(
            Mandatory=$true,
            ValueFromPipelineByPropertyName=$true
        )]
        [System.IO.FileInfo]
        $Path
    ,
        # передавать домены далее по конвейеру или нет
        [switch]
        $PassThru
    )

    process {
        Invoke-API `
            -HttpMethod 'POST' `
            -method 'api/add_logo' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -Params @{
                file = $Path
            } `
            -IsSuccessPredicate { [bool]$_.action.domains.domain.logo.'action-status'.get_item('success') } `
            -SuccessMsg "Логотип для домена $($DomainName) установлен." `
            -IsFailurePredicate { [bool]$_.action.domains.domain.logo.'action-status'.get_item('error') } `
            -FailureMsgFilter { $_.action.domains.domain.logo.'action-status'.error } `
        ;
        if ( $PassThru ) { $input };
    }
}  

function Remove-Logo {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API del_logo) предназначен для удаления логотипа домена.
        .Description
            Метод позволяет удалить логотип домена.
            Синтаксис запроса
                https://pddimp.yandex.ru/api/del_logo.xml ? token =<токен> & domain =<имя домена>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_del_logo.xml#domain-control_del_logo

        .Example
            Удаление логотипа для домена yourdomain.ru:
            Remove-Logo -DomainName 'yourdomain.ru';
        .Example
            Удаление логотипа с явным указанием токена для нескольких доменов:
            $token = Get-Token -DomainName 'maindomain.ru';
            'domain1.ru', 'domain2.ru' | Remove-Logo -Token $token
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true,
        ConfirmImpact="Low"
    )]
    
    param (
        # имя домена - любой из доменов, зарегистрированных под Вашей учётной записью на сервисах Яндекса
        # если явно домен не указан, то будет использован последний домен, указанный при вызовах yandex.api
        [Parameter(
            Mandatory=$false,
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет запрошен автоматически
        # через вызов Get-Token
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # передавать домены далее по конвейеру или нет
        [switch]
        $PassThru
    )

    process {
        Invoke-API `
            -method 'api/del_logo' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -SuccessMsg "Логотип для домена $($DomainName) удалён." `
        ;
        if ( $PassThru ) { $input };
    }
}  

function Get-Mailboxes {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API get_domain_users) Метод позволяет получить список почтовых ящиков.
        .Description
            Метод (обёртка над Яндекс.API get_domain_users) Метод позволяет получить список почтовых ящиков.
            Метод возвращает список ящиков в домене, привязанном к токену. 
            Синтаксис запроса
                https://pddimp.yandex.ru/get_domain_users.xml ? token =<токен> & on_page =<число записей на странице> & page =<номер страницы>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_get_domain_users.xml

        .Example
            Get-Mailboxes -DomainName 'csm.nov.ru';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true,
        ConfirmImpact="Low"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false,
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    )

    process {
        Invoke-API `
            -method 'get_domain_users' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -Params @{
                on_page = 1000; 
                page = 1
            } `
            -IsSuccessPredicate { [bool]$_.SelectSingleNode('page/domains/domain/emails/action-status') } `
            -IsFailurePredicate { [bool]$_.page.error } `
            -FailureMsgFilter { $_.page.error.reason } `
            -ResultFilter { 
                $_.page.domains.domain.emails.email `
                | %{ $_.name; } `
            } `
        ;
    }
}  

function Get-Admins {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API get_admins). Метод позволяет получить список дополнительных администраторов домена.
        .Description
            Метод (обёртка над Яндекс.API get_admins). Метод позволяет получить список дополнительных администраторов домена.
            Метод возвращает список дополнительных администраторов для домена, привязанного к токену. 
            Синтаксис запроса
                https://pddimp.yandex.ru/api/multiadmin/get_admins.xml ? token =<токен> & domain =<имя домена>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_get_admins.xml

        .Example
            Get-Admins -DomainName 'csm.nov.ru';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true,
        ConfirmImpact="Low"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false,
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    )

    process {
        Invoke-API `
            -method 'api/multiadmin/get_admins' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -IsSuccessPredicate { [bool]$_.SelectSingleNode('action/domain/status/success') } `
            -IsFailurePredicate { [bool]$_.SelectSingleNode('action/domain/status/error') } `
            -FailureMsgFilter { $_.action.domain.status.error } `
            -ResultFilter { 
                $_.SelectNodes('action/domain/other-admins/login') `
                | %{ $_.'#text'; } `
            } `
        ;
    }
}  

function Register-Admin {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API set_admin) предназначен для указания логина дополнительного администратора домена.
        .Description
            Метод (обёртка над Яндекс.API set_admin) предназначен для указания логина дополнительного администратора домена.
            В качестве логина может быть указан только логин на @yandex.ru, но не на домене, делегированном на Яндекс.
            Синтаксис запроса
                https://pddimp.yandex.ru/api/multiadmin/add_admin.xml ? token =<токен> & domain =<имя домена> & login =<логин администратора>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_add_admin.xml

        .Example
            Register-Admin -DomainName 'csm.nov.ru' -Credential 'sergei.e.gushchin';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true,
        ConfirmImpact="High"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false
            , ValueFromPipeline=$true
            , ValueFromPipelineByPropertyName=$true
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # Логин дополнительного администратора на @yandex.ru
        [Parameter(
            Mandatory=$true
            , Position=0
            , ValueFromRemainingArguments=$true
        )]
        [string]
        [ValidateNotNullOrEmpty()]
        [Alias("Admin")]
        [Alias("Name")]
        [Alias("Login")]
        $Credential
    ,
        # передавать домены далее по конвейеру или нет
        [switch]
        $PassThru
    )

    process {
        Invoke-API `
            -method 'api/multiadmin/add_admin' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -Params @{
                login = $Credential
            } `
            -IsSuccessPredicate { [bool]$_.SelectSingleNode('action/domain/status/success') } `
            -IsFailurePredicate { [bool]$_.SelectSingleNode('action/domain/status/error') } `
            -FailureMsgFilter { $_.action.domain.status.error } `
        ;
        if ( $PassThru ) { $input };
    }
}  

function Remove-Admin {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API del_admin) предназначен для удаления дополнительного администратора домена.
        .Description
            Метод (обёртка над Яндекс.API del_admin) предназначен для удаления дополнительного администратора домена.
            В качестве логина может быть указан только логин на @yandex.ru, но не на домене, делегированном на Яндекс.
            Синтаксис запроса
                https://pddimp.yandex.ru/api/multiadmin/del_admin.xml ? token =<токен> & domain =<имя домена> & login =<имя почтового ящика>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-control_del_admin.xml

        .Example
            Remove-Admin -DomainName 'csm.nov.ru' -Credential 'sergei.e.gushchin';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true,
        ConfirmImpact="High"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false
            , ValueFromPipeline=$true
            , ValueFromPipelineByPropertyName=$true
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # Логин дополнительного администратора на @yandex.ru
        [Parameter(
            Mandatory=$true
            , Position=0
            , ValueFromRemainingArguments=$true
        )]
        [string]
        [ValidateNotNullOrEmpty()]
        [Alias("Admin")]
        [Alias("Name")]
        [Alias("Login")]
        $Credential
    ,
        # передавать домены далее по конвейеру или нет
        [switch]
        $PassThru
    )

    process {
        Invoke-API `
            -method 'api/multiadmin/del_admin' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -Params @{
                login = $Credential
            } `
            -IsSuccessPredicate { [bool]$_.SelectSingleNode('action/domain/status/success') } `
            -IsFailurePredicate { [bool]$_.SelectSingleNode('action/domain/status/error') } `
            -FailureMsgFilter { $_.action.domain.status.error } `
        ;
        if ( $PassThru ) { $input };
    }
}  

function New-Mailbox {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API reg_user) предназначен для регистрации
            нового пользователя (ящика) на "припаркованном" на Яндексе домене.
        .Description
            Метод (обёртка над Яндекс.API reg_user) предназначен для регистрации
            нового пользователя (ящика) на "припаркованном" на Яндексе домене.
            Синтаксис запроса
                https://pddimp.yandex.ru/reg_user_token.xml ? token =<токен>
                & u_login =<логин пользователя> & u_password =<пароль пользователя>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-users_reg_user.xml

        .Example
            New-Mailbox -DomainName 'csm.nov.ru' -LName 'test_user' -Password 'testpassword';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true
        , ConfirmImpact="High"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false
            , ValueFromPipelineByPropertyName=$true
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # Учётная запись (lname для создаваемого ящика) на Вашем припаркованном домене
        [Parameter(
            Mandatory=$true
            , ValueFromPipelineByPropertyName=$true
        )]
        [System.String]
        [ValidateNotNullOrEmpty()]
        [Alias("Email")]
        [Alias("Login")]
        [Alias("mailNickname")]
        $LName
    ,
        # Пароль к создаваемой учётной записи. Может быть как зашифрованным (SecureString), так и простым текстом
        #(String)
        [Parameter(
            Mandatory=$true
            , ValueFromPipelineByPropertyName=$true
        )]
        [ValidateScript({ 
            [System.String] `
            , [System.Security.SecureString] `
            -contains ( $_.GetType() )
        })]
        [ValidateNotNullOrEmpty()]
        $Password
    ,
        # Фамилия пользователя
        [Parameter(
            Mandatory=$false
            , ValueFromPipelineByPropertyName=$true
            , ParameterSetName="ExtraAccountAttributes"
        )]
        [System.String]
        [ValidateNotNullOrEmpty()]
        [Alias("sn")]
        $SecondName
    ,
        # Имя пользователя
        [Parameter(
            Mandatory=$false
            , ValueFromPipelineByPropertyName=$true
            , ParameterSetName="ExtraAccountAttributes"
        )]
        [System.String]
        [ValidateNotNullOrEmpty()]
        [Alias("givenName")]
        $FirstName
    ,
        # Отчество пользователя
        [Parameter(
            Mandatory=$false
            , ValueFromPipelineByPropertyName=$true
            , ParameterSetName="ExtraAccountAttributes"
        )]
        [System.String]
        [ValidateNotNull()]
        $MiddleName
    ,
        # Пол пользователя
        [Parameter(
            Mandatory=$false
            , ValueFromPipelineByPropertyName=$true
            , ParameterSetName="ExtraAccountAttributes"
        )]
        [System.String]
        [ValidateSet("м", "ж")]
        $Sex
    ,
        # перезаписывать ли реквизиты существующих ящиков
        [switch]
        $Force
    ,
        # передавать домены далее по конвейеру или нет
        [switch]
        $PassThru
    )

    begin {
        $Mailboxes = @( Get-Mailboxes -DomainName $DomainName -Token $Token );
    }
    process {
        if ( $Password -is [System.Security.SecureString] ) {
            $Credential = New-Object System.Management.Automation.PSCredential( 
                $LName, 
                $Password
            );
            $Password = $Credential.GetNetworkCredential().Password;
        };
        $SexDig = switch ($Sex) {
            'м' { 1 }
            'ж' { 2 }
            default { 0 }
        };
        $IsMailboxExists = $Mailboxes -contains $LName;
        if ( $IsMailboxExists -and ( -not $Force ) ) {
            Write-Error "Создаваемый ящик $LName на домене $DomainName уже существует. Для переопределения его реквизитов используйте параметр -Force.";
        } else {
            if ( -not $IsMailboxExists ) {
                Write-Verbose "Создаваемый ящик $LName на домене $DomainName не существует - создаём.";
                Invoke-API `
                    -method 'api/reg_user' `
                    -Token ( Test-Token $DomainName $Token ) `
                    -DomainName $DomainName `
                    -Params @{
                        login = $LName;
                        passwd = $Password;
                    } `
                ;
            };
            if ( $PsCmdlet.ParameterSetName -eq 'ExtraAccountAttributes' ) {
                Write-Verbose "Изменяем реквизиты ящика $LName на домене $DomainName.";
                Invoke-API `
                    -method 'edit_user' `
                    -Token ( Test-Token $DomainName $Token ) `
                    -DomainName $DomainName `
                    -Params @{
                        login = $LName;
                        passwd = $Password;
                        iname = ( ($FirstName, $MiddleName | ? { $_ } ) -join ' ' );
                        fname = $SecondName;
                        sex = $SexDig;
                    } `
                    -IsSuccessPredicate { [bool]$_.page.ok } `
                    -IsFailurePredicate { [bool]$_.page.error } `
                    -FailureMsgFilter { $_.page.error.reason } `
                ;
            };
        };
        
        if ( $PassThru ) { $input };
    }
}  

function Edit-Mailbox {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API edit_user) предназначен для редактирования
            сведений о пользователе ящика на "припаркованном" на Яндексе домене.
        .Description
            Метод (обёртка над Яндекс.API edit_user) предназначен для редактирования
            сведений о пользователе ящика на "припаркованном" на Яндексе домене.
            Синтаксис запроса
                https://pddimp.yandex.ru/edit_user.xml ? 
                token =<токен>
                 & login =<логин пользователя>
                 & [password =<пароль пользователя>]
                 & [iname =<имя пользователя>]
                 & [fname =<фамилия пользователя>]
                 & [sex =<пол пользователя>]
                 & [hintq =<секретный вопрос>]
                 & [hinta =<ответ на секретный вопрос>]
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-users_edit_user.xml

        .Example
            Edit-Mailbox -DomainName 'csm.nov.ru' -LName 'test_user' -Password 'testpassword';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true
        , ConfirmImpact="High"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false
            , ValueFromPipelineByPropertyName=$true
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # Учётная запись (lname для создаваемого ящика) на Вашем припаркованном домене
        [Parameter(
            Mandatory=$true
            , ValueFromPipelineByPropertyName=$true
        )]
        [System.String]
        [ValidateNotNullOrEmpty()]
        [Alias("Email")]
        [Alias("Login")]
        [Alias("mailNickname")]
        $LName
    ,
        # Пароль к создаваемой учётной записи. Может быть как зашифрованным (SecureString), так и простым текстом
        #(String)
        [Parameter(
            Mandatory=$true
            , ValueFromPipelineByPropertyName=$true
        )]
        [ValidateScript({ 
            [System.String] `
            , [System.Security.SecureString] `
            -contains ( $_.GetType() )
        })]
        [ValidateNotNullOrEmpty()]
        $Password
    ,
        # Фамилия пользователя
        [Parameter(
            Mandatory=$false
            , ValueFromPipelineByPropertyName=$true
        )]
        [System.String]
        [ValidateNotNullOrEmpty()]
        [Alias("sn")]
        $SecondName
    ,
        # Имя пользователя
        [Parameter(
            Mandatory=$false
            , ValueFromPipelineByPropertyName=$true
        )]
        [System.String]
        [ValidateNotNullOrEmpty()]
        [Alias("givenName")]
        $FirstName
    ,
        # Отчество пользователя
        [Parameter(
            Mandatory=$false
            , ValueFromPipelineByPropertyName=$true
        )]
        [System.String]
        [ValidateNotNull()]
        $MiddleName
    ,
        # Пол пользователя
        [Parameter(
            Mandatory=$false
            , ValueFromPipelineByPropertyName=$true
        )]
        [System.String]
        [ValidateSet("м", "ж")]
        $Sex
    ,
        # передавать домены далее по конвейеру или нет
        [switch]
        $PassThru
    )

    process {
        if ( $Password -is [System.Security.SecureString] ) {
            $Credential = New-Object System.Management.Automation.PSCredential( 
                $LName, 
                $Password
            );
            $Password = $Credential.GetNetworkCredential().Password;
        };
        $Sex = switch ($Sex) {
            'м' { 1 }
            'ж' { 2 }
            default { 0 }
        };
        Write-Verbose "Изменяем реквизиты ящика $LName на домене $DomainName.";
        Invoke-API `
            -method 'edit_user' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -Params @{
                login = $LName;
                passwd = $Password;
                iname = ( ($FirstName, $MiddleName | ? { $_ } ) -join ' ' );
                fname = $SecondName;
            } `
            -IsSuccessPredicate { [bool]$_.page.ok } `
            -IsFailurePredicate { [bool]$_.page.error } `
            -FailureMsgFilter { $_.page.error.reason } `
        ;
        if ( $PassThru ) { $input };
    }
}  

function Remove-Mailbox {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API del_user) предназначен для удаления
            ящика на "припаркованном" на Яндексе домене.
        .Description
            Метод (обёртка над Яндекс.API del_user) предназначен для удаления
            ящика на "припаркованном" на Яндексе домене.
            Синтаксис запроса
                https://pddimp.yandex.ru/api/del_user.xml ? token =<токен> 
                & domain =<имя домена> & login =<имя почтового ящика>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-users_del_user.xml

        .Example
            Remove-Mailbox -DomainName 'csm.nov.ru' -LName 'test_user';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true
        , ConfirmImpact="High"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # Учётная запись (lname для создаваемого ящика) на Вашем припаркованном домене
        [Parameter(
            Mandatory=$true
            , ValueFromPipeline=$true
            , Position = 0
        )]
        [System.String[]]
        [ValidateNotNullOrEmpty()]
        [Alias("Email")]
        [Alias("Login")]
        [Alias("mailNickname")]
        $LName
    ,
        # передавать домены далее по конвейеру или нет
        [switch]
        $PassThru
    )

    process {
        $LName `
        | % {
            Invoke-API `
                -method 'api/del_user' `
                -Token ( Test-Token $DomainName $Token ) `
                -DomainName $DomainName `
                -Params @{
                    login = $_;
                } `
            ;
        };
        if ( $PassThru ) { $input };
    }
}  

function Get-MailListMembers {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API get_forward_list) предназначен для получения
            перенаправлений почты для ящика на "припаркованном" на Яндексе домене.
        .Description
            Метод (обёртка над Яндекс.API get_forward_list) предназначен для получения
            перенаправлений почты для ящика на "припаркованном" на Яндексе домене.
            Синтаксис запроса
                https://pddimp.yandex.ru/get_forward_list.xml ? token =<токен> 
                & login =<логин пользователя>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-users_get_forward_list.xml

        .Example
            Get-MailListMembers -DomainName 'csm.nov.ru' -LName 'sergei.s.betke';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true
        , ConfirmImpact="Low"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # Учётная запись (lname для создаваемого ящика) на Вашем припаркованном домене
        [Parameter(
            Mandatory=$true
            , Position=0
        )]
        [System.String]
        [ValidateNotNullOrEmpty()]
        [Alias("Email")]
        [Alias("Login")]
        [Alias("mailNickname")]
        [Alias("LName")]
        [Alias("MailList")]
        $MailListLName
    )

    process {
        Invoke-API `
            -method 'get_forward_list' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -Params @{
                login = $MailListLName;
            } `
            -IsSuccessPredicate { [bool]$_.page.ok } `
            -IsFailurePredicate { [bool]$_.page.error } `
            -FailureMsgFilter { $_.page.error.reason } `
            -ResultFilter { 
                $_.page.ok.filters.filter `
                | %{ $_.filter_param; } `
                | %{ 
                    $temp = $_ -match $reMailAddr;
                    $matches['lname'];
                } `
            } `
        ;
    }
}  

function New-MailListMember {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API set_forward) предназначен для создания
            перенаправлений почты для ящика на "припаркованном" на Яндексе домене.
        .Description
            Метод (обёртка над Яндекс.API set_forward) предназначен для создания
            перенаправлений почты для ящика на "припаркованном" на Яндексе домене.
            Синтаксис запроса
                https://pddimp.yandex.ru/set_forward.xml ? token =<токен> 
                & login =<логин пользователя> 
                & address =<e-mail для пересылки> 
                & copy =<признак сохранения исходников>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-users_set_forward.xml

        .Example
            New-MailListMember -DomainName 'csm.nov.ru' -MailListLName 'mail' -LName 'sergei.s.betke';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true
        , ConfirmImpact="Medium"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # Учётная запись (lname для создаваемого ящика) на Вашем припаркованном домене
        [Parameter(
            Mandatory=$true
        )]
        [System.String]
        [ValidateNotNullOrEmpty()]
        [Alias("MailList")]
        $MailListLName
    ,
        # Адрес электронной почты (lname) на том же домене для перенаправления почты 
        [Parameter(
            Mandatory=$true
            , ValueFromPipeline=$true
            , ValueFromPipelineByPropertyName=$true
        )]
        [System.String[]]
        [ValidateNotNullOrEmpty()]
        [Alias("Email")]
        [Alias("Login")]
        [Alias("mailNickname")]
        $LName
    ,
        # передавать домены далее по конвейеру или нет
        [switch]
        $PassThru
    )

    process {
        $res = Invoke-API `
            -method 'set_forward' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -Params @{
                login = $MailListLName;
                address = "$LName@$DomainName";
                copy = 'yes';
            } `
            -IsSuccessPredicate { [bool]$_.SelectSingleNode('page/ok'); } `
            -IsFailurePredicate { [bool]$_.page.error } `
            -FailureMsgFilter { $_.page.error.reason } `
        ;
        if ( $PassThru ) { $input } else { $res };
    }
}  

function Remove-MailListMember {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод (обёртка над Яндекс.API delete_forward) предназначен для удаления
            перенаправлений почты для ящика на "припаркованном" на Яндексе домене.
        .Description
            Метод (обёртка над Яндекс.API delete_forward) предназначен для удаления
            перенаправлений почты для ящика на "припаркованном" на Яндексе домене.
            Синтаксис запроса
                https://pddimp.yandex.ru/delete_forward.xml ? token =<токен> 
                & login =<логин пользователя> 
                & filter_id =<id фильтра>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/domain-users_delete_forward.xml

        .Example
            Remove-MailListMember -DomainName 'csm.nov.ru' -MailListLName 'mail' -LName 'sergei.s.betke';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true
        , ConfirmImpact="High"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # Учётная запись (lname для создаваемого ящика) на Вашем припаркованном домене
        [Parameter(
            Mandatory=$true
        )]
        [System.String]
        [ValidateNotNullOrEmpty()]
        [Alias("MailList")]
        $MailListLName
    ,
        # Адрес электронной почты (lname) на том же домене для перенаправления почты 
        [Parameter(
            Mandatory=$true
            , ValueFromPipeline=$true
            , ValueFromPipelineByPropertyName=$true
        )]
        [System.String[]]
        [ValidateNotNullOrEmpty()]
        [Alias("Email")]
        [Alias("Login")]
        [Alias("mailNickname")]
        $LName
    ,
        # передавать домены далее по конвейеру или нет
        [switch]
        $PassThru
    )

    begin {
        $MailListMembers = Invoke-API `
            -method 'get_forward_list' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -Params @{
                login = $MailListLName;
            } `
            -IsSuccessPredicate { [bool]$_.page.ok } `
            -IsFailurePredicate { [bool]$_.page.error } `
            -FailureMsgFilter { $_.page.error.reason } `
            -ResultFilter { 
                @(
                    $_.SelectNodes('page/ok/filters/filter');
                );
            } `
        ;
    }
    process {
        $LName `
        | % {
            $TestLName = $_;
            $id = (
                $MailListMembers `
                | ? { $_.filter_param -eq "$TestLName@$DomainName" } `
                | % { $_.id } `
            );
            if ( $id ) {
                Write-Verbose "Удаляемый адресат $_ обнаружен среди перенаправлений для ящика $MailListLName@$DomainName, id=$id.";
                Invoke-API `
                    -method 'delete_forward' `
                    -Token ( Test-Token $DomainName $Token ) `
                    -DomainName $DomainName `
                    -Params @{
                        login = $MailListLName;
                        filter_id = $id;
                    } `
                    -IsSuccessPredicate { [bool]$_.SelectSingleNode('page/ok'); } `
                    -IsFailurePredicate { [bool]$_.page.error } `
                    -FailureMsgFilter { $_.page.error.reason } `
                ;
            } else {
                Write-Verbose "Удаляемый адресат $_ не обнаружен среди перенаправлений для ящика $MailListLName@$DomainName.";
            };
        };
        if ( $PassThru ) { $input };
    }
}  

function New-MailList {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Создание группы рассылки, включающей всех пользователей домена. Обёртка
            над create_general_maillist.
        .Description
            Создание группы рассылки, включающей всех пользователей домена. Обёртка
            над create_general_maillist.
            Синтаксис запроса:
                https://pddimp.yandex.ru/api/create_general_maillist.xml ? token =<токен> 
                & domain =<имя домена> 
                & ml_name =<имя рассылки>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/maillist_create_general_maillist.xml

        .Example
            New-MailList -DomainName 'csm.nov.ru' -MailListLName 'all';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true
        , ConfirmImpact="Medium"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # Учётная запись (lname для создаваемого ящика) на Вашем припаркованном домене
        [Parameter(
            Mandatory=$true
        )]
        [System.String]
        [ValidateNotNullOrEmpty()]
        [Alias("MailList")]
        $MailListLName
    ,
        [Parameter(
            Mandatory=$false
            , ValueFromPipeline=$true
            , ValueFromPipelineByPropertyName=$true
        )]
        [System.String[]]
        [Alias("Email")]
        [Alias("Login")]
        [Alias("mailNickname")]
        $LName = @()
    )

    begin {
        if ( 
            (     
                Get-Mailboxes `
                    -Token ( Test-Token $DomainName $Token ) `
                    -DomainName $DomainName `
            ) -contains $MailListLName
        ) {
            Write-Error "Невозможно создать группу рассылки $MailListLName для домена $DomainName: группа или ящик с таким адресом уже существуют.";
        } else {
            Invoke-API `
                -method 'api/create_general_maillist' `
                -Token ( Test-Token $DomainName $Token ) `
                -DomainName $DomainName `
                -Params @{
                    ml_name = $MailListLName;
                } `
            ;
            Sleep -Milliseconds 2500; # даём время Яндексу добавить в эту группу все адреса, чтобы потом их убить
            Get-MailListMembers `
                -DomainName $DomainName `
                -Token $Token `
                -MailListLName $MailListLName `
            | Remove-MailListMember `
                -DomainName $DomainName `
                -Token $Token `
                -MailListLName $MailListLName `
            ;
        };
    }
    process {
        $LName `
        | New-MailListMember `
            -DomainName $DomainName `
            -Token $Token `
            -MailListLName $MailListLName `
        ;
    }
}  

function Remove-MailList {
    <#
        .Component
            API Яндекс.Почты для доменов
        .Synopsis
            Метод предназначен для удаления группы рассылки на "припаркованном" на Яндексе домене.
            Обёртка для delete_general_maillist.
        .Description
            Метод предназначен для удаления группы рассылки на "припаркованном" на Яндексе домене.
            Обёртка для delete_general_maillist.
            Синтаксис запроса:
                https://pddimp.yandex.ru/api/delete_general_maillist.xml ? token =<токен> 
                & domain =<имя домена>
                & ml_name =<имя рассылки>
        .Link

http://api.yandex.ru/pdd/doc/api-pdd/reference/maillist_delete_general_maillist.xml

        .Example
            Remove-MailList -DomainName 'csm.nov.ru' -MailListLName 'test_maillist';
    #>

    [CmdletBinding(
        SupportsShouldProcess=$true
        , ConfirmImpact="High"
    )]
    
    param (
        # имя домена, зарегистрированного на сервисах Яндекса
        [Parameter(
            Mandatory=$false
        )]
        [string]
        [ValidateScript( { $_ -match "^$($reDomain)$" } )]
        [Alias("domain_name")]
        [Alias("Domain")]
        $DomainName = $DefaultDomain
    ,
        # авторизационный токен, полученный через Get-Token. Если не указан, то будет использован
        # последний полученный
        [Parameter(
        )]
        [string]
        [AllowEmptyString()]
        $Token
    ,
        # Адрес (без домена, lname) удаляемой группы рассылки на Вашем припаркованном домене
        [Parameter(
            Mandatory=$true
            , ValueFromPipeline=$true
            , Position=0
        )]
        [System.String]
        [ValidateNotNullOrEmpty()]
        [Alias("MailList")]
        $MailListLName
    )

    process {
        Invoke-API `
            -method 'api/delete_general_maillist' `
            -Token ( Test-Token $DomainName $Token ) `
            -DomainName $DomainName `
            -Params @{
                ml_name = $MailListLName;
            } `
            -IsFailurePredicate { -not $_.SelectSingleNode('action/status/success') } `
        ;
        Remove-Mailbox `
            -DomainName $DomainName `
            -Token $Token `
            -LName $MailListLName `
        ;
    }
}

Export-ModuleMember `
    Get-Token `
    , Register-Domain `
    , Remove-Domain `
    , Set-DefaultEmail `
    , Set-Logo `
    , Remove-Logo `
    , Get-Mailboxes `
    , Get-Admins `
    , Register-Admin `
    , Remove-Admin `
    , New-Mailbox `
    , Edit-Mailbox `
    , Remove-Mailbox `
    , Get-MailListMembers `
    , New-MailListMember `
    , Remove-MailListMember `
    , New-MailList `
    , Remove-MailList `
;

Код приведён здесь только для ознакомления, его текущие версии – только в github.

А теперь – большая ложка дёгтя!

В процессе создания этого модуля изучил API Google Apps. Google мало того, что предоставляет формализованное описание API (SOAP, для некоторых  API – WADL), так ещё и поставляет готовые библиотеки для многих языков программирования. В PowerShell мы вполне могли бы использовать .net сборку. Яндекс не предлагает библиотек. Но страшно не это. Яндекс не предлагает и формализованного описания ни в одном более менее промышленном стандарте! Разработчики активно спорят с потенциальными “потребителями” своего API по вопросу выбора архитектуры API: почему REST, а не SOAP. Хотя предлагаемое API нельзя отнести к разряду критичных по времени, а по сему – лучшим на мой взгляд был бы именно SOAP, – не важно, REST так REST. Но что мешало и для REST API разместить хотя бы WADL описание? Но этого нет. Поэтому автоматизировать процесс создания модуля – обёртки по формализованному описанию возможности не представилось.

Кроме того, в процессе программирования выявились несоответствия заявленной в документации схемы ответов фактической. И, опять-таки, xml схема ответов не описана никакими средствами, кроме как русским языком.

И не в последнюю очередь следует отметить бедность API по сравнению с web интерфейсом. В частности, управление группами рассылок ограничено созданием general maillist – группы рассылки, включающей в себя все адреса домена, в том числе – и других групп рассылок. При этом циклы не анализируются на этапе создания (проверял!). Именно поэтому в коде командлет, управляющих группами рассылок, Вы найдёте неочевидные действия и откровенные заплатки (в частности, при создании группы рассылки мне пришлось создавать general maillist, ждать, пока в асинхронном исполнении Яндекс заполнит группу всеми адресами домена, после чего – удалять их все  с тем, чтобы дать возможность самостоятельного управления членством в группе.

Ощущается архитектурная ошибка, приводящая к столь различному уровню API, пользовательского интерфейса и API ядра:пользовательский интерфейс посредством AJAX использует иные интерфейсы, нежели предложены нам в API. Поэтому возможности пользовательского интерфейса и API столь различаются. Остаётся только в качестве образца здесь привести инициативу Microsoft аж 2007 года – всё управление – через powershell. В том числе и все визуальные консоли управления – через сценарии powershell взаимодействуют с управляемыми объектами. И теперь, через 5 лет, мы видим результаты – через powershell действительно мы можем сделать практически всё, что можем и через визуальные средства управления, и даже существенно больше!

Итого, выводы: работать с Яндекс.API Почты для домена на сегодня можно. Но сравнивать с Google Apps API даже не стоит – просто разного уровня API. Одно решение – “для себя”, другое – “для людей”. Надеюсь, в скором времени ситуация с API у Яндекс изменится к лучшему… Хочется, всё-таки, гордиться отечественным продуктом, а не продуктом Google.

Отзывы » (1)

  1. Дмитрий:

    А пример csv можете выложить?

Опубликовать комментарий

XHTML: Вы можете использовать следующие HTML теги: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>

Tags Связь с комментариями статьи:
RSS комментарии
Обратная ссылка