The command webmail_keys_gen() creates a GINA account.
This command generates a GINA account and sends the initial password to the sender of the original email or alternatively to an email address that can optionally be specified.
Structure of the command
webmail_keys_gen(['recipient'], ['password_length'], ['no_pw_mail_if_sms_sent'], ['template']);
Return value
positive |
always |
Parameters
recipient (optional)
Defines the email address to which the email with the initial password is to be sent.
If no email address is specified, the sender's email address is used.
password_length (optional)
Defines the length of the initial password. The "0" (zero) stands for an empty password.
If the parameter is not specified, the default value of the configuration interface is used (see Initial password Password length).
no_pw_mail_if_sms_sent (optional)
With this option ('1'), the email with the initial password to the sender is prevented if this could already be transmitted via SMS (see also keyword [SMS:] in Table 1 of the chapter Controlling The Appliance).
Possible values:
•true, yes or 1
•false, no or 0
The default setting is 0
template (optional) (new in 14.0.5)
Defines the GINA domains to be used.
If no parameter is specified, the template is selected based on the email domain of the sender address (see Mail System Managed domains Settings GINA domain)
Example 1
Line |
Code |
---|---|
01 |
webmail_keys_gen('','8'); |
Explanation:
In this example, a GINA account is created. The sender of the original email receives an email notification with the initial password. This initial password has '8' (eight) characters.
Example 2
Line |
Code |
---|---|
01 |
webmail_keys_gen('','','1'); |
Explanation:
In this example, a GINA account is created. The password length that will apply is determined by the settings of the GINA domain to be used - the sender of the original email only receives an email notification with the initial password for the recipient if this has not already been sent via SMS.