The createaccount() command creates new user accounts.
A user account is a local SEPPmail Secure E-Mail Gateway user account. This user account can be viewed in the menu Users.
|
If createaccount() is accessed in Custom macros and commands for all e-mails BEFORE processing, the command incoming() must first be used to determine the direction of an email (incoming/outgoing),since no decision regarding the validity and the direction of the email has been made here yet. We recommend using macros for flagging only (e.g. via ldap_compare()) in order to then carry out a corresponding action in Custom commands for outgoing emails BEFORE encryption. |
Structure of the command
createaccount([0],['userID'],['name']);
Return value
positive |
always |
Parameters
keys
This parameter has been deactivated. Generating key material is to be done exclusively using the command createkeys().
If additional parameters are to be used, keys must be set to zero (0).
userID (optional)
This parameter specifies the unique ID of the user.
If this parameter is not specified, the user's email address is used as the userID for creating the user. Special characters are automatically replaced.
Variables available!
name (optional)
This parameter specifies the name of the user.
If this parameter is not specified, the display name is used for creating the user, or if this does not exist, the user's email address is used as the name. Special characters are automatically replaced.
Variables available!
Example 1
Line |
Code |
|---|---|
01 |
if (!authenticated()) { |
03 |
createaccount(); |
04 |
log(1,'user account generated'); |
05 |
} |
Explanation
The example evaluates the negated return value of the command authenticated() from (line 01). If the internal sender of the email could be authenticated successfully, due to the negation, the return value is false. If the authentication has failed, due to the negation, the return value is true and the indicated instruction block applies. In the example, a user account would therefore be created for the sender (line 02) and a corresponding log entry would be created (line 03).
