ShaunSocial docs ShaunSocial user guide
Version 1.5.6
  • 1.5.6 (this version)

ShaunSocial user guide 1.5.6 / AdminCP

E-mail

Admin

Your site sends e-mails on its own (welcome messages, codes, notifications) and you can send your own e-mail campaigns to your members. This page explains how to change the wording of every automatic e-mail, in every language, and how to write, target and send a bulk e-mail campaign. How your site connects to an e-mail account is explained on Server services.

Mail templates#

Last updated: 2026-11-17 · v1.5.6

Every automatic e-mail your site sends has a template: a subject and a text you can rewrite. The list shows all templates by name, with a Search box above it; each row has an Edit link. Plugins you install can add templates of their own to this list.

E-mails go out from the moment your site is installed: after installing, the Mail engine in the e-mail settings is Mail (your server's own mail program), and that AdminCP setting is the one your site uses. To send through an e-mail account instead, see An outgoing e-mail account (SMTP). If you choose SMTP there but leave Hostname empty, no e-mail is sent at all.

AdminCP, Mail Templates: the list of e-mail templates by name, each with an Edit link, and the Search box above it
AdminCP → Site Settings → Mail Templates: the list of templates with the search box. Screenshot taken 2026-11-17.

How an e-mail is put together#

Each e-mail your site sends has the same frame:

  • at the top, your Site logo (AdminCP → Site Settings → Site Information, see Site Images);
  • in the middle, the text of the template. Most templates start with [header] and end with [footer]: these are replaced by the text of the four special templates Header (Members), Footer (Members), Header (Non-members) and Footer (Non-members). Change the header or footer once and every e-mail changes with it;
  • at the bottom, a fixed line: "If you don't want to receive these emails in the future, please click here to unsubscribe".

The Members header and footer are used when the e-mail goes to someone with an account on your site; the Non-members ones when it goes to an address without an account (for example an invitation or a shared link sent to someone who has not joined). Contact-form messages go to your Site email: if that address belongs to an account on your site (after installing it is usually the admin's own address), they get the Members header and footer.

Change the signature first

After installing, both headers say "Dear [recipient_name]," and both footers say "Best Regards, Social Network Administration". Edit Footer (Members) and Footer (Non-members) and sign with your own community's name.

Edit a template#

  1. Open AdminCP → Site Settings → Mail Templates and click Edit next to the template. Use Search to find it by name.

    What you should see: one box per language of your site, each with Subject, Available Placeholders and Content.

  2. In the box of the language you want to change, edit Subject and Content. Content is a text editor with bold, links and other formatting.
  3. Use only the placeholders listed under Available Placeholders for that template, plus the general ones in the next section. Type them exactly, square brackets included.
  4. Click Submit under that language's box.

    What you should see: "Mail template has been successfully saved." Each language box has its own Submit button and saves only that language.

Which language a member receives: the language they chose on your site; if they never chose one, or for an address without an account, your default language (see Manage languages). A language added later starts with a copy of the English texts, so translate the templates after adding a language.

The editor turns a web address you type into a link. For a link with your own words, select the text and use the link button. Keep placeholders that stand for an address inside a link, as the original texts do (for example [link]).

Editing the Contact email template: an English box and an Español box, each with Subject, Available Placeholders, the Content editor and a Submit button
Editing a mail template: a box per language with Subject, Available Placeholders, Content and Submit. Screenshot taken 2026-11-17.

Placeholders you can use in every template#

PlaceholderReplaced by
[site_name]your Site title
[recipient_name]the member's name; "Sir/Madam" for an address without an account
[recipient_email]the address the e-mail goes to
[header], [footer]the text of the matching header and footer template (not inside the header and footer templates themselves)

The Invitation and Shared texts also use [sender_title], the name of the member who sent them; keep it if you rewrite those texts.

The templates: accounts and sign-in#

TemplateSent whenIts own placeholders
Welcomesomeone signs up and no e-mail confirmation is needed[login_link]
Welcome with verification codesomeone signs up while Require email validation is on (see Who can sign up)[code]
Welcome with passwordyou create an account in AdminCP → Users → Manage Users with Verified email ticked (without it, the new member gets Welcome with verification code instead)[login_link], [password]
Verify emaila member confirms or changes their e-mail address[code]
Forgot passwordsomeone asks to reset their password[code]
Two-factor verify emaila member signs in with two-factor authentication by e-mail (see Two-factor authentication)[code]
Admin changes passwordan admin changes a member's password in the AdminCP with Notify to user ticked[password]
Active useran admin switches an account to active, or a moderation restriction on the account ends[link]
Inactive useran admin switches an account to inactive[link] (your contact page)
Auto Inactive by system emailan account is switched off automatically because members reported it too many times in one day[link] (your contact page)
Moderation actionmoderators take an action on a member's account[action], [reason], [duration], [next_step], [link]
Moderation appeal resulta member's appeal against a moderation action has been decided[action], [result], [note]
When admin reject verifyan admin rejects a verification request (the verified badge) of a member or a business page[reason], [link]

The templates: members and activity#

TemplateSent whenIts own placeholders
Header (Non-members), Footer (Non-members), Header (Members), Footer (Members)never on their own: they are inserted where another template says [header] and [footer]none
Invitationa member invites people by e-mail from the Invite page[message], [ref_link]
Shareda member shares something with e-mail addresses[message], [link]
Contact emaila visitor sends the contact form; it goes to your Site email (see The contact form). Its subject line is always the subject the visitor typed; the template's Subject is not used[name], [email], [subject], [message]
Notifications summarya member has unread notifications and has not opened them for about a day; it lists up to ten of them. Only for members who keep Daily email notification on[blade] (the list of notifications; keep it in the text)
Bulk Emailyou send a bulk e-mail campaign (see Bulk e-mail campaigns). The campaign's own subject and text are used, with the members' header and footer around it; the text of this template is not used[content]

The templates: payments and subscriptions#

These are sent by the paid features. They stay in the list even when you do not use the feature.

TemplateFeatureIts own placeholders
Remind users to deposit more when the balance in the ewallet is lowereWallet[link]
When a store refund takes credits back from the eWalleteWallet (purchases in the mobile apps)[amount], [balance], [link]
When the eWallet balance is too low to renew a subscriptioneWallet[name], [date], [amount], [balance], [shortfall], [link]
When a user buys subscription successfully, When reminder subscription, When stop subscriptionMembership: bought, about to renew, ended[link]; the reminder also [date], [name], [amount]; the stop also [reason]
When a user is moved onto a free membership packageMembership[link], [package_name]
When a free membership request is rejectedMembership[link], [reason]
When a profile subscription is about to renew, When a profile subscription stopsPaid content (subscribing to a creator)[name], [link]; the reminder also [date], [amount]; the stop also [reason]
When a featured listing subscription is about to renew, When a featured listing subscription stopsMarketplacethe same as the line above
When a featured page subscription is about to renew, When a featured page subscription stopsBusiness pagesthe same as the line above

When members turn e-mails off#

Members turn e-mails off in their Settings → Email Notifications (switch Email Notifications), or by clicking the unsubscribe link at the bottom of any e-mail. In the same place, Daily email notification turns off only the notifications summary.

An address that has turned e-mails off still receives: Welcome with verification code, Verify email, Forgot password, Admin changes password, Active user, Inactive user, Moderation action and Moderation appeal result. Every other template, bulk e-mail campaigns included, is not sent to it.

Your own Site email

The same applies to the address in Site email (AdminCP → Site Settings → Site Information). If it has turned e-mails off, for example because someone once clicked the unsubscribe link in an e-mail sent to it, contact-form messages and bulk e-mail tests sent to it are not delivered, and no error is shown. If that address belongs to an account, sign in with it and keep Email Notifications on in Settings → Email Notifications, or use a Site email that has not turned e-mails off.

Two-factor codes by e-mail

A member who turned e-mails off does not receive the Two-factor verify email code either. If such a member cannot sign in, remove their two-factor authentication as described in When a member loses their phone, or ask them to choose another two-factor method.

Bulk e-mail campaigns#

Last updated: 2026-11-17 · v1.5.6

A bulk e-mail campaign sends one message to many members at once: an announcement, a newsletter, an invitation to an event. You choose who receives it by member role, gender and country, and you can write it in each of your site's languages. Super admins can use it, and moderators whose role has the Manage Bulk Email permission.

The screen lists your campaigns with Subject, Sent By, Recipients, Status, Created and a Detail link. Compose New Campaign starts a new one.

AdminCP, Bulk Email: two sent campaigns with Subject, Sent By, Recipients, Status, Created and Detail, and the Compose New Campaign button
AdminCP → Site Settings → Bulk Email: the campaign list and the Compose New Campaign button. Screenshot taken 2026-11-17.

Write and send a campaign#

  1. Open AdminCP → Site Settings → Bulk Email and click Compose New Campaign.

    What you should see: Compose Bulk Email with a Subject and a Content field for each active language, the Recipients filters, and below the form a second box, Send Test Email.

  2. Fill in Subject and Content for your default language (marked *; they are required). For other languages, fill them in or leave them blank: members using a language you left blank receive the default language text. In the subject and text you can use [recipient_name] (the member's name) and [site_name].
  3. Choose the recipients. A filter you leave empty includes everyone for that filter.
    FilterWhat it does
    User Rolesonly members with the roles you pick (you can pick several)
    GenderAll, or one gender from AdminCP → Users → Manage Genders
    Countryonly members whose profile is set to one of the countries you pick
  4. Click Preview Recipient Count.

    What you should see: Estimated recipients followed by the number of members who match.

  5. Send yourself a test: in Send Test Email check the address in Send test email to (your own address is filled in), choose the Language to preview and click Send Test.

    What you should see: "Test email was sent successfully! Please check your inbox to make sure it is delivered." The test uses what is in the fields right now and goes out immediately; for a language left blank it shows the default language text. If the test never arrives although the message says it was sent, check that the address has not turned e-mails off (see When members turn e-mails off).

  6. When the test looks right, click Send Campaign and confirm "Are you sure you want to send this campaign? This cannot be undone." with OK.

    What you should see: the campaign list with "The bulk email campaign has been queued for sending." and your campaign at the top with the status Queued.

There is no undo

A campaign starts as soon as you click Send Campaign. It cannot be scheduled for later, edited or stopped, so send a test first.

Compose Bulk Email: an English subject and message, an empty Spanish subject and message, User Roles set to Member, Estimated recipients 9, Preview Recipient Count, Send Campaign, and the Send Test Email box
Compose Bulk Email: subject and content per language, the recipient filters with the estimated count, and the Send Test Email box. Screenshot taken 2026-11-17.

Who receives a campaign#

  • Every account with an e-mail address that matches the filters, in the language that member uses on your site.
  • Accounts that are not active (waiting for approval or switched off) are included when they match. Business pages are never included.
  • Members who turned e-mails off (see When members turn e-mails off) are skipped when the e-mail is sent, although they appear in the campaign's recipient list.
  • The e-mail has your members' header and footer around your text, your logo at the top and the unsubscribe line at the bottom (see How an e-mail is put together).

How a campaign goes out#

Campaigns are sent in the background by the cron job, so they never slow down the AdminCP. Without a working cron job a campaign stays Queued forever (see Cron job).

StatusMeaning
Queuedwaiting; the cron job picks it up within about a minute
Sendingthe list of recipients is being made and their e-mails are being lined up
Sentevery e-mail of the campaign is lined up for sending (see below)
Failedsomething went wrong while the recipients were being lined up; the detail page shows how far it got

The e-mails themselves then leave in batches: each minute the cron job sends as many as Mail count in AdminCP → Site Settings → General Configuration → E-mail Settings (25 after installing). This happens whatever the Email queue setting is. A campaign to 1,000 members therefore takes about 40 minutes to arrive in every inbox, even though its status already says Sent. Raise Mail count only as far as your e-mail account allows (many providers limit how many e-mails you may send per hour).

For your server administrator

With the background queue on (SHAUN_QUEUE=true, see Queue worker), campaigns and their e-mails are handled by the queue worker on the mail_many queue instead of the cron job, and Mail count does not apply. The worker must serve that queue, or campaigns never leave.

Check a campaign#

Click Detail next to a campaign. The page shows its Subject, Sent By, Status, Total Recipients, Created and Sent At, the Recipient Filters you chose (User Roles, Gender, Country), the Content, and the list of Recipients (member, e-mail address and when they were added). Until the cron job has picked up the campaign the list says "No recipients have been recorded for this campaign yet." Back to list returns to the campaign list.

The detail page of the sent campaign Weekend Hikers: Saturday ridge walk, with sender, status, recipients and dates, the recipient filters, the content per language and the list of nine recipients
The detail page of a sent campaign, with its filters and the list of recipients. Screenshot taken 2026-11-17.

Change log#

Last updated: 2026-11-17 · v1.5.6

Date (GMT+7)SectionWhat changed
2026-11-17mail-templates, bulk-emailCorrections after review: the Site email and the Members header, links typed in the editor, where the Send Test Email box is, the confirmation of Send Campaign, a Site email that has turned e-mails off; the page title is now "E-mail".
2026-11-17allFirst version for 1.5.6, written from the 1.5.6 code. The list of templates and their placeholders was checked against a freshly installed demo site; the sending times of campaigns were read from the code, not measured.