View Source

Class EmailUserInviteSender

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Security

Assembly: Umbraco.Infrastructure.dll

Syntax

public class EmailUserInviteSender : IUserInviteSender

Constructors

EmailUserInviteSender(IEmailSender, ILocalizedTextService, IOptions<GlobalSettings>)

Declaration

[Obsolete("Please use the constructor with all parameters. Scheduled for removal in Umbraco 18.")]
public EmailUserInviteSender(IEmailSender emailSender, ILocalizedTextService localizedTextService, IOptions<GlobalSettings> globalSettings)

Parameters

Type	Name	Description
IEmailSender	emailSender
ILocalizedTextService	localizedTextService
IOptions<GlobalSettings>	globalSettings

EmailUserInviteSender(IEmailSender, ILocalizedTextService, IOptions<GlobalSettings>, IOptions<SecuritySettings>)

Declaration

public EmailUserInviteSender(IEmailSender emailSender, ILocalizedTextService localizedTextService, IOptions<GlobalSettings> globalSettings, IOptions<SecuritySettings> securitySettings)

Parameters

Type	Name	Description
IEmailSender	emailSender
ILocalizedTextService	localizedTextService
IOptions<GlobalSettings>	globalSettings
IOptions<SecuritySettings>	securitySettings

Methods

CanSendInvites()

Determines whether the sender is configured and able to send invites.

Declaration

public bool CanSendInvites()

Returns

Type	Description
bool	true if the sender can send invites; otherwise, false.

InviteUser(UserInvitationMessage)

Sends an invitation to the user.

Declaration

public Task InviteUser(UserInvitationMessage invite)

Parameters

Type	Name	Description
UserInvitationMessage	invite	The invitation message containing user and invite details.

Returns

Type	Description
Task	A task representing the asynchronous operation.