Service Info: mailadmin
Service Description
This service provides operations that allow you to administrate the mail system of Hornbill ESP.
Available Operations
The following operations are available for the mailadmin service. You can click on each operation to see detailed information about that operation.
| Operation | Description |
|---|---|
| checkServiceAvailability | This method is used to check the service availability. |
| createPersonalMailbox | This method is used to create a new personal mailbox. |
| createSharedMailbox | This method is used to create a new shared mailbox. |
| deleteMailbox | This method is used to delete an existing personal or shared mailbox. |
| domainCreate | Invoke this method to create a mail domain. |
| domainDKIMClear | Invoke this operation remove DKIM on this domain |
| domainDKIMEnable | Invoke this operation to enable DKIM on this domain. |
| domainDKIMGet | Invoke this operation to get the DKIM configuration on this domain. |
| domainDKIMVerify | Invoke this operation to verify the DKIM configuration on this domain. This will make a DNS call to verify the domain contains the public key |
| domainDelete | Invoke this method to delete the mail domain and all assigned addresses. |
| domainGetInfo | Invoke this method to get the domain properties. |
| domainGetList | This method is used to get the list of domain accepted/routed by the mail server. |
| domainSPFCheck | This method is used to perform a Sender Policy Framework (SPF) check against the specified domain. This will do a DNS lookup for the specified domain and look for a specific include directive 'include:_spf.hornbill.com' that gives the 'hornbill.com' servers permission to send e-mail messages on behalf of the specified domain. Hornbill E-Mail Integration |
| domainSetInfo | Invoke this method to update the domain properties. |
| forceMailImporterCycle | This method is used to force the mail importer to run a mail import cycle. This operation most useful when testing/validating the system behavior as it allows you to initiate the mail import cycle without waiting for its natural cycle time (mail.importer.pollInterval). |
| forceMailRoutingCycle | This method is used to force the mail server to run a mail routing cycle. This operation most useful when testing/validating the system behavior as it allows you to initiate the mail routing cycle without waiting for its natural cycle time. |
| getMailConnectors | This method is used to get the list of mailboxes and associated mail connectors. |
| getMailboxStatus | This method is used to get mailbox status (the folders, message number, used space). |
| getPersonalMailboxRights | This method is used to get the mailbox rights for the specified user's personal mailbox. |
| getServiceStats | This method is used to get the service status/diagnostic information. |
| mailboxAddressAdd | Invoke this method to add associated address to the mailbox. |
| mailboxAddressDelete | Invoke this method to delete associated address from the mailbox. |
| mailboxAddressGetList | Invoke this method to get the list of the associated mailbox addresses. |
| mailboxConnectorAdd | Invoke this method to add inbound mail connector to the shared mailbox. |
| mailboxConnectorDelete | Invoke this method to delete inbound mail connector from the shared mailbox. |
| mailboxConnectorGet | Invoke this method to add inbound mail connector to the shared mailbox. |
| mailboxConnectorTest | Invoke this method to test and validate the connector settings and credentials. |
| mailboxConnectorUpdate | Invoke this method to update the inbound mail connector of the shared mailbox. |
| mailboxInboundConnectorTest | Invoke this method to test and validate saved inbound (IMAP4/POP3) connector settings and credentials. |
| mailboxSmtpConnectorTest | Invoke this method to test and validate saved outbound (SMTP) connector settings and credentials. |
| personalMailboxGetInfo | Invoke this method to get the personal mailbox properties. |
| personalMailboxGetList | This method is used to get the list of personal mailboxes in the system. |
| personalMailboxSetInfo | Invoke this method to update the personal mailbox properties. |
| reloadMailRoutingRules | This method is used to tell the mail server to re-load the inbound mail routing rules from the database. |
| routingRuleChangeOrder | This operation is used to change the priority order of an inbound routing rule. |
| routingRuleCreate | This operation is used to create an inbound routing rule. |
| routingRuleDelete | This operation is used to delete one or more inbound routing rules. |
| routingRuleGet | This operation is used to get information about an inbound routing rule. |
| routingRuleGetFlowcodeOperationList | This operation is used to get a list of flowcode operations used for auto responder specific functionality |
| routingRuleList | This operation is used to get a list of inbound routing rules defined on this system. The rules are returned in priority order |
| routingRuleUpdate | This operation is used to update an inbound routing rule. |
| setPersonalMailboxRights | This method is used to grant or revoke rights to a user for the specified personal mailbox. |
| sharedMailboxGetInfo | Invoke this method to get the shared mailbox properties. |
| sharedMailboxGetList | This method is used to get the list of shared mailboxes in the system. |
| sharedMailboxGetRoles | Returns a list of roles associated to a shared mailbox |
| sharedMailboxSetInfo | Invoke this method to update the shared mailbox properties. |