Sending Emails - Revision history

Luke at 19:54, 29 September 2022

2022-09-29T19:54:07Z

← Older revision		Revision as of 19:54, 29 September 2022
Line 100:		Line 100:

	Tokens are directly available as a feature from the editor as well, so you can use them with no code necessary. If you want to pass a potentially token containing, visually editable value into your component as a prop, simply specify a propType of "jsx" for the prop.		Tokens are directly available as a feature from the editor as well, so you can use them with no code necessary. If you want to pass a potentially token containing, visually editable value into your component as a prop, simply specify a propType of "jsx" for the prop.

			= Pre-installed Emails =

			If your module is being distributed you may want to pre-install emails. All AutoService's can use the InstallEmail method typically from their constructor but it can be called at any point. The method is just a simple wrapper over EmailTemplateService.Create - the only thing it does differently is it checks if an email with the same key already exists. If it already exists, it will do nothing. This allows a default email template to be installed but then can be edited as much as wanted in the admin panel. Because of the "key exists" check, you can also override a default template with another default template simply by making sure your install runs first. In AutoService this can be done by setting a [[Service load order\|load priority]].

			<syntaxhighlight lang="csharp">

			InstallEmails(
			new EmailTemplate()
			{
			Name = "Welcome",
			Subject = "Welcome aboard!",
			Key = "welcome_member_email",
			BodyJson = "{\"module\":\"Email/Default\",\"content\":[{\"module\":\"Email/Centered\",\"data\":{}," +
			"\"content\":\"Thanks for joining! If you have any questions please reach out.\"}]}"
			}
			// , new EmailTemplate() ...
			);

			</syntaxhighlight>

Luke: /* Sending a particular template */

2022-09-12T11:59:10Z

Sending a particular template

← Older revision		Revision as of 11:59, 12 September 2022
Line 13:		Line 13:

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">

			// To get a reference to the EmailTemplateService, either add it in to your service constructor like this:
			// public MyService(EmailTemplateService emails)
			// or you can use Services.Get<EmailTemplateService>() - Services is in the Api.Startup namespace.


	User aUserObject; // The User you want to send the email to.		User aUserObject; // The User you want to send the email to.

Luke: /* Custom Data */

2022-07-13T11:22:26Z

Custom Data

← Older revision		Revision as of 11:22, 13 July 2022
Line 94:		Line 94:
	</syntaxhighlight>		</syntaxhighlight>

	Tokens are directly available as a feature from the editor as well, so you can use them with no code necessary.		Tokens are directly available as a feature from the editor as well, so you can use them with no code necessary. If you want to pass a potentially token containing, visually editable value into your component as a prop, simply specify a propType of "jsx" for the prop.

Luke: /* Custom Data */

2022-07-13T11:21:17Z

Custom Data

← Older revision		Revision as of 11:21, 13 July 2022
Line 93:		Line 93:

	</syntaxhighlight>		</syntaxhighlight>

			Tokens are directly available as a feature from the editor as well, so you can use them with no code necessary.

Luke: /* Custom Data */

2022-07-13T11:19:43Z

Custom Data

← Older revision		Revision as of 11:19, 13 July 2022
Line 45:		Line 45:

	recipient.CustomData = new { // This object must be JSON serialisable.		recipient.CustomData = new { // This object must be JSON serialisable.
	Token = "SomeMagicTokenValue"		Token = "SomeMagicTokenValue",
			Anything = 123123 // Add as many fields as you need.
	};		};

Luke: /* Custom Data */

2022-07-13T11:17:11Z

Custom Data

← Older revision		Revision as of 11:17, 13 July 2022
Line 30:		Line 30:
	=Custom Data=		=Custom Data=

	Firstly, an email can use [[Loop]], [[Content]] ~~and more generally webRequest~~. When this happens it is in the context of the user receiving the email and the locale used is based on the LocaleId of the User object. The email renderer does not actually send a request to "itself" - the code is short circuited to effectively directly mount the targeted [[Services\|API service]].		Firstly, an email can use [[Loop]] and [[Content]]. When this happens it is in the context of the user receiving the email and the locale used is based on the LocaleId of the User object. The email renderer does not actually send a request to "itself" - the code is short circuited to effectively directly mount the targeted [[Services\|API service]].

	Often though when you send an email it will contain some dynamic information - i.e. information which is specific to "this" email. For example in a password reset request, the email contains a URL with a token which is unique to the reset request. This is done by passing "Custom data" which is set per recipient, allowing each recipient to vary too.		Often though when you send an email it will contain some dynamic information - i.e. information which is specific to "this" email. For example in a password reset request, the email contains a URL with a token which is unique to the reset request. This is done by passing "Custom data" which is set per recipient, allowing each recipient to vary too.

Luke at 11:15, 13 July 2022

2022-07-13T11:15:18Z

← Older revision		Revision as of 11:15, 13 July 2022
Line 1:		Line 1:
	SocialStack aims to have one way of rendering content which is going out to end users by default; i.e. if someone is visiting via the web they'll see React components. If they see an email it's the same - the server renders React components into the email for them. So, creating an email is somewhat similar to [[Editing Pages\|creating a page]] - the only notable difference is it's done in the "Email Templates" section of the admin panel.		SocialStack aims to have one way of rendering content which is going out to end users by default; i.e. if someone is visiting via the web they'll see React components. If they see an email it's the same - the server renders React components into the email for them. So, creating an email is somewhat similar to [[Editing Pages\|creating a page]] - the only notable difference is it's done in the "Email Templates" section of the admin panel.

	The components used need to be email friendly too. Most email clients don't currently support things like flexbox for example. Components in the Email/* group must always be email friendly; components in UI/* ~~space~~ may or may not be. It's suggested to copy the JSON of one of the default email templates as a starting point.		The components used need to be email friendly too. Most email clients don't currently support things like flexbox for example. Components in the Email/* group must always be email friendly; components in UI/* group may or may not be. It's suggested to copy the JSON of one of the default email templates as a starting point.

	=Email Key=		=Email Key=

Luke: /* Custom Data */

2022-07-13T11:14:00Z

Custom Data

← Older revision		Revision as of 11:14, 13 July 2022
Line 30:		Line 30:
	=Custom Data=		=Custom Data=

	Firstly, an email can use [[Loop]], [[Content]] and more generally webRequest. When this happens it is in the context of the user receiving the email and the locale used is based on the LocaleId of the User object. The email renderer does not actually send a request to "itself" - the code is short circuited to effectively directly mount the targeted service.		Firstly, an email can use [[Loop]], [[Content]] and more generally webRequest. When this happens it is in the context of the user receiving the email and the locale used is based on the LocaleId of the User object. The email renderer does not actually send a request to "itself" - the code is short circuited to effectively directly mount the targeted [[Services\|API service]].

	Often though when you send an email it will contain some dynamic information - i.e. information which is specific to "this" email. For example in a password reset request, the email contains a URL with a token which is unique to the reset request. This is done by passing "Custom data" which is set per recipient, allowing each recipient to vary too.		Often though when you send an email it will contain some dynamic information - i.e. information which is specific to "this" email. For example in a password reset request, the email contains a URL with a token which is unique to the reset request. This is done by passing "Custom data" which is set per recipient, allowing each recipient to vary too.

Luke: /* Custom Data */

2022-07-13T11:13:25Z

Custom Data

← Older revision		Revision as of 11:13, 13 July 2022
Line 30:		Line 30:
	=Custom Data=		=Custom Data=

	Firstly, an email can use [[Loop]], [[Content]] and more generally webRequest. When this happens it is in the context of the user receiving the email and the locale used is based on the LocaleId of the User object.		Firstly, an email can use [[Loop]], [[Content]] and more generally webRequest. When this happens it is in the context of the user receiving the email and the locale used is based on the LocaleId of the User object. The email renderer does not actually send a request to "itself" - the code is short circuited to effectively directly mount the targeted service.

	Often though when you send an email it will contain some dynamic information - i.e. information which is specific to "this" email. For example in a password reset request, the email contains a URL with a token which is unique to the reset request. This is done by passing "Custom data" which is set per recipient, allowing each recipient to vary too.		Often though when you send an email it will contain some dynamic information - i.e. information which is specific to "this" email. For example in a password reset request, the email contains a URL with a token which is unique to the reset request. This is done by passing "Custom data" which is set per recipient, allowing each recipient to vary too.

Luke: /* Sending a particular template */

2022-07-13T11:11:43Z

Sending a particular template

← Older revision		Revision as of 11:11, 13 July 2022
Line 10:		Line 10:
	=Sending a particular template=		=Sending a particular template=

	To send a template, use the EmailTemplateService.~~Send~~ method:		To send a template, use the EmailTemplateService.SendAsync method:

	<syntaxhighlight lang="csharp">		<syntaxhighlight lang="csharp">
Line 25:		Line 25:

	</syntaxhighlight>		</syntaxhighlight>

			If you don't need to wait for it to send, call SendAsync from within a _= Task.Run().

	=Custom Data=		=Custom Data=