add_mail_recipients
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
add_mail_recipients [2020/01/20 18:12] – lucy | add_mail_recipients [2021/10/26 13:17] – [Import Recipients] lucysecurity | ||
---|---|---|---|
Line 1: | Line 1: | ||
===== Introduction===== | ===== Introduction===== | ||
- | Every campaign needs a recipient group to work. The recipient group are the users who receive the attack simulation or awareness content. You can create multiple groups for a single campaign. Groups can be used within LUCY to target users with specific phishing or training campaigns. Many organizations start by grouping users by department, location (if you have multiple office locations), or even domains (if there are multiple domains). The recipients can be in any number of groups and you can set up an unlimited number of groups. | + | Every campaign needs a recipient group to work. The recipient group is the users who receive the attack simulation or awareness content. You can create multiple groups for a single campaign. Groups can be used within LUCY to target users with specific phishing or training campaigns. Many organizations start by grouping users by department, location (if you have multiple office locations), or even domains (if there are multiple domains). The recipients can be in any number of groups and you can set up an unlimited number of groups. |
===== How to Enter Your Recipients? ===== | ===== How to Enter Your Recipients? ===== | ||
- | Recipients and groups can be configured under Admin/Recipients. | + | Recipients and groups can be configured under **Settings -> Recipients**. |
{{ 45.jpg? | {{ 45.jpg? | ||
- | You can either add them manually (1), import them (2) or search the internet by using the " | + | You can either add them manually (1), import them (2), or search the internet by using the " |
{{ 46.jpg? | {{ 46.jpg? | ||
Line 21: | Line 21: | ||
===== Import Recipients ===== | ===== Import Recipients ===== | ||
- | You can import the recipients via file or via [[ldap_integration|LDAP]]. There is no restriction on the number of recipients you can add to a group (even though your license might restrict the sending of all mails). | + | You can import the recipients via file, via [[ldap_integration|LDAP]] or via [[azure_synchronization|Azure AD synchronization]]. There is no restriction on the number of recipients you can add to a group (even though your license might restrict the sending of all emails). |
- | **SYNTAX**: LUCY requires a [[recipient_import_and_syntax_issues|special syntax]]. Otherwise it will throw an error. In LUCY version > 3.1 it will continue the import with the correct recipients. In an awareness or phishing campaign which is send via email, it will need at least the mail address as a mandatory field. All other fields are voluntary. | + | **SYNTAX**: LUCY requires a [[recipient_import_and_syntax_issues|special syntax]]. Otherwise, it will throw an error. In LUCY version > 3.1 it will continue the import with the correct recipients. In an awareness or phishing campaign which is sent via email, it will need at least the mail address as a mandatory field. All other fields are voluntary. |
- | The import file should contain one recipient per line. Each record should consist of 1 to 7 columns separated by the colon symbol | + | The import file should contain one recipient per line. Each record should consist of 1 to 12 columns separated by the colon (:) or semi-colon symbol (;). All columns, except for the first one, are optional. If you want to skip the column value, just don't type anything between |
* 1.Email - Recipient' | * 1.Email - Recipient' | ||
- | * 2.Name - Recipient' | + | * 2.Full Name - Recipient' |
- | * 3.Staff - Job position or related | + | * 3.Staff - Job position or related |
* 4.Location - Recipient' | * 4.Location - Recipient' | ||
* 5.Division - Company division | * 5.Division - Company division | ||
* 6.Comment - Any custom comment | * 6.Comment - Any custom comment | ||
* 7.Link - Unique link part for the Landing Page. Only use this if access to the internet by clicking on a link in an email is not possible (e.g. if you use some terminal client or a separate browser to access the internet). More information about this can be found [[configuration_for_clients_that_cannot_click_on_links_in_mails|here]]. | * 7.Link - Unique link part for the Landing Page. Only use this if access to the internet by clicking on a link in an email is not possible (e.g. if you use some terminal client or a separate browser to access the internet). More information about this can be found [[configuration_for_clients_that_cannot_click_on_links_in_mails|here]]. | ||
- | * 8.Phone - recipient | + | * 8.Phone - Recipient' |
- | * 9.Language - recipient | + | * 9.Language - Recipient' |
+ | * 10.Gender - Recipient' | ||
+ | * 11.First Name - Recipient' | ||
+ | * 12.Last Name - Recipient' | ||
- | Note about language: if you upload a recipient group file (txt or CSV) and want to specify the language you need to use the English description (example "spanish"). | + | Also in LUCY, it is possible to add **Custom Fields** to recipient groups. So if there are any custom fields one has to add values for these fields by adding columns to the end of the line separating them with colons or semi-colons too. |
+ | Note about language: if you upload a recipient group file (txt or CSV) and want to specify the language you need to use the English description (example "Spanish"). | ||
- | **FILE FORMAT**: You can import a plain text file (.txt) or -csv format and name it as you want. | + | **FILE FORMAT**: You can import a plain text file (.txt) or CSV (.csv) format and name it as you want. |
- | **EXAMPLE**: | + | **EXAMPLE**: |
- | john@example.com: | + | john@example.com: |
- | marcus@aurelius.com: | + | marcus@aurelius.com: |
- | peter@example | + | peter@example.com\\ |
- | sarah@example: | + | sarah@example.com: |
- | + | ||
- | {{testrecipient2.png? | + | |
+ | {{import_recipients.png? | ||
+ | Please note, that using the file import into one particular group containing new or updated info in any fields (except email address) would result in the data being overwritten with the new file import.\\ | ||
+ | For example, Recipient Group 1 contains a recipient with an email user1@default.com who has Country set as Luxemburg. The file import is initiated into this recipient group and the user has Country file in the .csv file set as Germany. Once the import is complete, the info will be updated with the over-written Country value to Germany. | ||
===== Adding multiple groups in a campaign | ===== Adding multiple groups in a campaign | ||
Line 60: | Line 65: | ||
{{ mapping_rec.png? | {{ mapping_rec.png? | ||
- | The default mapping is " | + | The default mapping is " |
- | The scenario association can be used to control, which group gets which attack scenario. In the screenshot you see (2) that all the available scenarios added to the campaign will be displayed. Example: If you select 2 scenarios with a specific group, each user from this group will get two emails (one from scenario 1 and one from scenario 2). If you don't want the users to get multiple emails, you can enable the checkbox " | + | The scenario association can be used to control, which group gets which attack scenario. In the screenshot, you see (2) that all the available scenarios added to the campaign will be displayed. Example: If you select 2 scenarios with a specific group, each user from this group will get two emails (one from scenario 1 and one from scenario 2). If you don't want the users to get multiple emails, you can enable the checkbox " |
Line 72: | Line 77: | ||
===== Automatic adding of recipients in a group (LDAP SYNC) ===== | ===== Automatic adding of recipients in a group (LDAP SYNC) ===== | ||
- | You can add your recipients by LDAP. How to setup LDAP you can find here [[ldap_integration|LDAP Integration]] | + | You can add your recipients by an LDAP server. How to setup LDAP you can find here [[ldap_integration|LDAP Integration]]. |
+ | |||
+ | :!: Note, this configuration will not be active if there are global settings for recipients import disabled. | ||
{{ ldapsync.png? | {{ ldapsync.png? | ||
Line 83: | Line 90: | ||
Step 3: Rename your group in order to identify it better | Step 3: Rename your group in order to identify it better | ||
- | As an alternative you can also hover over the link and look at the group ID. When you hover over the groups within the generic recipient settings, you will see also the corresponding ID's. | + | As an alternative, you can also hover over the link and look at the group ID. When you hover over the groups within the generic recipient settings, you will see also the corresponding ID's. |
{{ recipient_association.png? | {{ recipient_association.png? | ||
Line 110: | Line 117: | ||
===== Disable recipients from a group within a campaign ===== | ===== Disable recipients from a group within a campaign ===== | ||
- | You can load a group into LUCY and then uncheck users, you don't want to test or train in this specific campaign. Just click on the according checkbox: | + | You can load a group into LUCY and then uncheck users, you don't want to test or train in this specific campaign. Just click on the according |
{{ recipient_filtering.png? | {{ recipient_filtering.png? | ||
Line 117: | Line 124: | ||
===== Recipient actions within a running campaign ===== | ===== Recipient actions within a running campaign ===== | ||
- | Under the statistics/ | + | Under the statistics/ |
{{ recipien_man.png? | {{ recipien_man.png? | ||
Line 132: | Line 139: | ||
===== Import Error-Log ===== | ===== Import Error-Log ===== | ||
- | LUCY will create an import error log which will help you to quickly identify import errors with mail addresses that had a syntax error. For LUCY please [[recipient_import_and_syntax_issues|click here]]. Please | + | LUCY will create an import error log which will help you to quickly identify import errors with mail addresses that had a syntax error. For LUCY please [[recipient_import_and_syntax_issues|click here]]. Please |
{{ import_error.png? | {{ import_error.png? | ||
Line 139: | Line 146: | ||
===== Custom Recipient Fields ===== | ===== Custom Recipient Fields ===== | ||
- | In LUCY you have the ability to create custom recipient fields. You can add any new recipient attribute you want (e.g. city, gender, education etc.). Those attributes can be used for using customized statistics in LUCY (dashboard filters or raw exports). | + | In LUCY you have the ability to create custom recipient fields. You can add any new recipient attribute you want (e.g. city, gender, education, etc.). Those attributes can be used for using customized statistics in LUCY (dashboard filters or raw exports). |
Line 145: | Line 152: | ||
In order to create a new custom field go to recipients. Under the recipient link you will find the " | In order to create a new custom field go to recipients. Under the recipient link you will find the " | ||
- | {{ recip_custom.png?600 }} | + | {{ custom_fields1.png?600 }} |
The new recipient attribute (can be freely chosen) is then added as a new attribute in the recipient list: | The new recipient attribute (can be freely chosen) is then added as a new attribute in the recipient list: | ||
- | {{ recipient_custom2.png?600 }} | + | {{ custom_fields2.png?600 }} |
- | {{ recipient_csutom3.png?600 }} | + | {{ custom_fields3.png?600 }} |
====== E-Mail Scanning Feature (E-Mail Spider) ====== | ====== E-Mail Scanning Feature (E-Mail Spider) ====== | ||
- | Under the recipient tab you find an option to scan for mail addresses | + | Under the recipient tab, you find an option to scan for mail addresses |
{{ scanmails.png? | {{ scanmails.png? | ||
Line 164: | Line 171: | ||
====== Analysis of the campaign based on recipient attributes ====== | ====== Analysis of the campaign based on recipient attributes ====== | ||
- | All attributes defined within the Recipient group can be analyzed within the campagin | + | All attributes defined within the Recipient group can be analyzed within the campaign |
{{ custom_attr_stats.png? | {{ custom_attr_stats.png? | ||
add_mail_recipients.txt · Last modified: 2021/10/26 13:18 by lucysecurity