pem.cqmail.editEmailAddresses

This method is supported by Operations starting from version 5.2

This method modifies the list of e-mail addresses for a specified Service User which has the QMail E-mail service assigned.

The method has the following input parameters:

Name

Type

Short Description

[subscription_id]

int

ID of the Subscription containing the QMail E-mail service. This parameter is optional.

Note: This parameter is deprecated.

login

string

Login of the Service User

[emails_to_add]

array of structs

The list of e-mail addresses that will be added.

  • name

string

Local part (e-mail address before the @ sign). For example: addr01

  • [domain_name]

string

Name of the domain to add a e-mail address for. There are the following use cases:

  • This parameter is omitted. In this case Operations adds an 'All-Domains' e-mail address. For example: addr01@<all-domains>.
  • This parameter is specified. In this case Operations adds a e-mail address for the domain specified. For example: addr01@example.com.

[emails_to_remove]

array of structs

The list of e-mail addresses that will be removed.

  • name

string

Local part (e-mail address before the @ sign). For example: addr02

  • [domain_name]

string

Name of the domain to remove a e-mail address for. There are the following use cases:

  • This parameter is omitted. In this case Operations removes an 'All-Domains' e-mail address. For example: addr02@<all-domains>.
  • This parameter is specified. In this case Operations removes a e-mail address for the domain specified. For example: addr02@example.com.

The method has no output parameters.

Note: This method can also be called under Reseller permissions.