SEPPmailAPI

2.0.0-beta1

Receive and manipulate your SEPPmail Appliance beginning with SEPPmail Version 12.1.0.
  With the REST-API you can retrieve and set information via REST, including the option to mass-generate users.
  This PowerShell module is a wrapper around this API to allow more convenient operation and interaction from the command line.

Minimum PowerShell version

5.1

This is a prerelease version of SEPPmailAPI.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name SEPPmailAPI -AllowPrerelease

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name SEPPmailAPI -Prerelease

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) SEPPmail AG. All rights reserved.

Package Details

Author(s)

  • The SEPPmail Dev-Team

Tags

SEPPmail REST-API Windows Linux MacOS

Functions

Set-SMAConfiguration Get-SMAConfiguration New-SMAConfiguration Remove-SMAConfiguration Test-SMAConfiguration Find-SMACustomer Get-SMACustomer New-SMACustomer Set-SMACustomer Remove-SMACustomer Export-SMACustomer Import-SMACustomer Add-SMACustomerAdmin Remove-SMACustomerAdmin Find-SMAGinaUser Get-SMAGinaUser New-SMAGinaUser Set-SMAGinaUser Remove-SMAGinaUser Find-SMAGroup Get-SMAGroup New-SMAGroup Set-SMAGroup Remove-SMAGroup Add-SMAGroupMember Remove-SMAGroupMember Get-SMAUser Find-SMAUser New-SMAUser Set-SMAUser Remove-SMAUser Get-SMAStatistics Get-SMALicense Get-SMALftStatistics Get-SMASystemApplyConfig Get-SMASystemComment Set-SMASystemComment Get-SMASystemHostName Set-SMASystemHostName Get-SMASystemGui Set-SMASystemGui Get-SMASystemWebMailGui Set-SMASystemWebMailGui Get-SMASystemKeyServer Set-SMASystemKeyServer Get-SMASystemSysLog Set-SMASystemSysLog Get-SMASystemLogRotate Set-SMASystemLogRotate Get-SMASystemProxy Set-SMASystemProxy Get-SMASystemMpkiProxy Set-SMASystemMpkiProxy Get-SMASystemOcspCheck Set-SMASystemOcspCheck Get-SMASystemTimeZone Set-SMASystemTimeZone Get-SMASystemDateAndTime Set-SMASystemDateAndTime Get-SMASystemSNMP Set-SMASystemSNMP Get-SMASystemNRPE Set-SMASystemNRPE Get-SMASystemZABBIX Set-SMASystemZABBIX Get-SMASystemVmTools Set-SMASystemVmTools Get-SMASystemIpConfig Set-SMASystemIpConfigV4 Get-SMASystemIpAliasConfig Get-SMASystemRoute Get-SMASystemActiveRoutes Get-SMASystemDns Get-SMASystemDnsLocalZones Get-SMASystemSettings Set-SMASystemSettings Get-SMASystemSmtpLoadBalancer Set-SMASystemSmtpLoadBalancer Get-SMAClusterInfo Find-SMADisclaimer Get-SMADisclaimer New-SMADisclaimer Set-SMADisclaimer Remove-SMADisclaimer Get-SMADisclaimerInclude New-SMADisclaimerInclude Remove-SMADisclaimerInclude Get-SMAMailProcessingRuleSet Update-SMAMailProcessingRuleSet Get-SMAMailProcessingRuleSetMisc Set-SMAMailProcessingRuleSetMisc Get-SMAMailProcessingRuleSetSettings Get-SMAMailProcessingExtendedFields New-SMAMailprocessingExtendedFields Remove-SMAMailprocessingExtendedFields Get-SMAMailProcessingSystemExtendedFields Find-SMACryptoDomain Get-SMACryptoDomain Get-SMACryptoDomainKey Get-SMAEncInfo Find-SMAMailSystemtemplate Get-SMAMailSystemtemplate New-SMATemplate Set-SMATemplate Remove-SMATemplate Find-SMATemplateInclude Get-SMATemplateInclude New-SMATemplateInclude Remove-SMATemplateInclude Get-SMAUserKey Remove-SMAUserKey New-SMAApplianceReport New-SMAMailConfigReport New-SMACustomerUserReport New-SMAGinaReport New-SMAStatisticsReport Get-SMAMailSystemSettings Get-SMAMailSystemSettingsRbl New-SMAMailSystemSettingsRbl Set-SMAMailSystemSettingsRbl Remove-SMAMailSystemSettingsRbl Get-SMAMailSystemSettingsBlwl New-SMAMailSystemSettingsBlwl Set-SMAMailSystemSettingsBlwl Remove-SMAMailSystemSettingsBlwl Get-SMAMailSystemSettingsRelaying New-SMAMailSystemSettingsRelaying Remove-SMAMailSystemSettingsRelaying Get-SMAMailSystemSettingsRelayingForManagedDomain New-SMAMailSystemSettingsRelayingForManagedDomain Remove-SMAMailSystemSettingsRelayingForManagedDomain Find-SMAMailSystemManagedDomain Get-SMAMailSystemManagedDomain New-SMAMailSystemManagedDomain Set-SMAMailSystemManagedDomain Remove-SMAMailSystemManagedDomain Find-SMAMailSystemTlsDomain Get-SMAMailSystemTlsDomain New-SMAMailSystemTlsDomain Set-SMAMailSystemTlsDomain Remove-SMAMailSystemTlsDomain Get-SMASsl Import-SMASsl Push-SMASsltoCluster Find-SMAWebMailDomain Get-SMAWebMailDomain Set-SMAWebMailDomain New-SMAWebMailDomain Remove-SMAWebMailDomain Get-SMAWebMailSettings Set-SMAWebMailSettings

PSEditions

Desktop Core

Dependencies

Release Notes

260121: Initial release - preparation for SM Release 12.1.0 - User path only

050221: User management stable - working with SM Dev Release 12.1.0

080221: 0.5.3 - Fixed TLS issue on older PS5 (WS2016) machines, cleanup exported commands

110321: 0.8.0 - All v1 CmdLets done, cosmetics and testing starting now

020421: 0.8.1 - Adding Support for Credential based security with Token/secret

070721: 0.9.0 - Adding Support for multiple configs and SecretStore

260721: 0.9.1 - Adding Support for Encryption Information

170921: 0.9.2 - Adding Support for ManagedDomain, MailTemplate, Disclaimer

180921: 0.9.3 - Adding Support for Statistics

270921: 0.9.4 - Adding Support for Webmail (GINA) users

031021: 0.9.5 - Adding Support for Groups

071021: 1.0.0 - First Release compatible with SEPpmail 12.1

091021: 1.0.1 - Signing of psd1 file added

141021: 1.0.5 - Linux/macOS test-smaconfig fixed, securestrig fixed, Module init SEPPmail_ModuleCfg fixed.

141025: 2.0.0 - internal alpha - Major rework to support SEPPmail API v2.0 - requires SEPPmail 14.0 or higher.

060326: 2.0.0 - beta2 first public release for beta testing for customers and partners - requires SEPPmail 15.0 or higher.

FileList

Version History

Version Downloads Last updated
2.0.0-beta1 (current version) 6 6/24/2026
1.1.0 346 7/17/2024
1.0.5 461 10/15/2021