SendWelcomeEmailForUser API¶

Sends a welcome email to a specified user. For native-authenticated users the email includes a 48-hour password reset link. For externally-authenticated users it includes their authentication source name. Requires an administrator, a User Manager, or a manager of the user's library.

Endpoint¶

/srv.asmx/SendWelcomeEmailForUser

Methods¶

• GET /srv.asmx/SendWelcomeEmailForUser?authenticationTicket=...&userName=...
• POST /srv.asmx/SendWelcomeEmailForUser (form data)
• SOAP Action: http://tempuri.org/SendWelcomeEmailForUser

Parameters¶

Response¶

Success Response¶

<root success="true" />

Error Response¶

<root success="false" error="[ErrorCode] Error message" />

Required Permissions¶

The caller must be allowed to create the user: an administrator, a member of [User Managers], or a manager of the user's library (for a user local to it). Up to 8.7 only administrators could.

Email Content¶

The email sent depends on the user's authentication type:

The email is rendered in the user's configured language preference.

Example¶

Request (GET)¶

GET /srv.asmx/SendWelcomeEmailForUser?authenticationTicket=abc123&userName=jdoe HTTP/1.1

Request (POST)¶

POST /srv.asmx/SendWelcomeEmailForUser HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=abc123&userName=jdoe

Error Conditions¶

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

Hands the welcome message for one user to the mail agent.

await call('SendWelcomeEmailForUser', { authenticationTicket: ticket, userName: 'jsmith' });

There is no "already welcomed" state: calling it again sends it again. The answer says the message was handed over, not that it was delivered - the address is whatever CreateUser stored, which is not checked.

Notes¶

• The password reset link embedded in native-account welcome emails expires after 48 hours.
• The SMTP server must be configured in appsettings.json for emails to be delivered.

Error Codes¶

The errorCode values this operation returns, checked against a running server: