==[[PhplistDocumentation Phplist Documentation]] » [[ListAndUserFunctionsInfo List and User functions]] » [[ListUsersInfo Users]] » ==
----
===== User File: documentation =====

In phplist, a **user** corresponds to one email. Each email, in turn, is linked to a ##user file## in which are stored values chosen among the list of available [[ConfigureAttributesInfo attributes]]. These attributes can be chosen by the user him/herself if they are listed in the [[ConfigureSubscribePageInfo subscribe pages]], or by the admins if they are only listed in the admin area.

A ##User File## contains the list of **all** the existing attributes, with the corresponding values for each user. It also contains the list of mailinglists the admin owns, and shows to which of these the user is subscribed.

Only admins have access to ##user files##, and they can modify all the information for each user using this page.

==== Description ====

##**back to the list of users**##
~To return to the [[ListUsersInfo List Users]] page, where you left off before clicking on a user's email (for example, if you were listing users 150 to 200, you will return to the same page).

##**back to the search results**##
~To return to the [[ListUsersInfo List Users]] page, as you left it after having done a search (for example, if you searched all emails with "domain.com", you will return to the list displaying the results of this search).

~{{table columns="5" cells="delete; john@web.com ; update page ; unsubscribe page ; history"}}

##**delete**##
~Delete will delete the user from all lists and also from the database.

##**update page**##
~To view the ##preferences## page as it appears to the user when he/she clicks on their personal link (//preferencesurl//). By modifying a user's file this way instead of doing it in the admin area, the user will receive a confirmation email with all the changes. Otherwise, the user would receive no confirmation email.

##**unsubscribe page**##
~To view the public ##unsubscribe## page, as it appears to the user when he/she wishes to unsubscribe from one or various lists. By unsubscribing a user this way instead of doing it in the admin area (by unticking the subscription to lists), the user will receive a confirmation email saying he/she has been **permanently unsubscribed** from the system. In other words, the user has been **blacklisted**. To remove a user from the blacklist, go to the user's [[UserHistoryInfo history]].

##**history**##
~To view a history of all the changes made to this user's file, including the list of messages this user received. See [[UserHistoryInfo user's history]] for more.

=== User details ===

~Note: Descriptions marked with * have additional remarks below.

{{table columns="3" cells="Attribute;Data (Example);DESCRIPTION; ID;1;Each user is given a unique ID number by PHPlist; Email;john@web.com;Only one email can be entered in this field; Is this user confirmed (1/0);1;1=yes, 0=no * ; Is this user blacklisted;0;1=yes, 0=no * ; Number of bounces on this user;0;Total number of bounced messages for this user * ; Entered;2005-03-05 13:57:59;Date/time when the user first subscribed to any list;Last Modified;20050306123000;Date/time when the user last modified his/her details;Unique ID for User;41f0e3d602a3d253498...;PHPlist attributes a unique ID to each user * ;Send this user HTML emails;0;1=yes, 0=no;Which page was used to subscribe;1 ;Useful when there are several subscribe pages;RSS Frequency;weekly;Several options are possible: (empty)/daily/weekly/monthly * ;Password;;The user's password (this feature must be enabled by the site administrator) * ;Last time password was changed;;self-explanatory;Is this account disabled?;0;*** NOT OPERATIONAL - do not use this setting***;Additional data;;?????;Foreign Key;;The Foreign Key field is meant to establish a relationship between the database of Phplist and another application's database. If you only use Phplist, you will not need to use it.;Country; [pulldown menu]; One example of attribute. All the other attributes begin to be listed at this point."}}

##**Is this user confirmed (1/0)**##
~When a user subscribes to one of your lists, a confirmation email is automatically sent to the email provided in the subscribe page. The user must click on the personal CONFIRMATIONURL contained in the email to confirm his/her subscription. Unconfirmed users do not receive any messages sent to lists. An admin can confirm a user manually by replacing 0 with 1.

##**Is this user blacklisted**##
~This feature allows you to mark a user as having chosen to **never** receive anymore emails from this system. The user's email //remains// in the database in order to avoid someone/something from subscribing the user //again// to the system //without// his/her knowledge.
~When a user chooses to unsubscribe from your mailinglist system, the user is considered as blacklisted. Currently, the only way to blacklist a user is to go to the public ##/?p=unsubscribe## page and follow the instructions.

##**Number of bounces on this user**##
~The number of bounced messages. A bounced message is a message that did not reach the user for a number of possible reasons. For more, see ''bounced messages...''

##**Unique ID for User**##
~A unique string is given to each user by phplist. This string is used in personalized ""URLs"" to confirm one's subscription (confirmationURL), to modify one's preferences, etc. In most systems, for instance, to reach the preferences pages for a given user, you paste this string after the following URL: ##...mysite.com/lists/?p=preferences&uid=## (##...mysite.com/lists/?p=preferences&uid=41f0e3d602a3d253498...## in this example).

##**RSS Frequency**##
~This feature must be enabled by the site administrator. See [[RssFunctionsInfo RSS]] for more.

##**Password**##
~This feature must be enabled by the site administrator with the ##''ASKFORPASSWORD''## setting in config.php. If enabled, each user can choose his/her personal password which will allow him/her to modify his/her personal file in the preferences pages.
~If you use passwords, you can store them encrypted or in plain text. If you want to encrypt them, you will need to enable the ##''ENCRYPTPASSWORD''## setting in config.php. **Note**: if you use encrypted passwords, users can only request you as an administrator to reset the password. They will not be able to request the password from the system.


=== Mailinglist membership ===

Example:
%%[checkbox] list one
[checkbox] list two
[save changes]%%
~Note: Only the lists which the administrator owns are displayed here. The administrator can check/uncheck the user from any of the available lists.

**IMPORTANT**: **to save any changes** made to the user's details and mailinglist memberships, you must **click on #%save changes#%**.


**Related pages:**
~-[[ListListsInfo Lists]]
~-[[UserHistoryInfo User History]]
~-[[ConfigureSubscribePageInfo Subscribe Page]]

----
CategoryDocumentation