Difference between revisions of "Email field"

Latest revision as of 21:29, 11 April 2023

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

Metadata Fields: Arclanguage - Base64 - Bigint - Boolean - Compound - Counter - Dataobjref - Date - Decimal - Email - Fields - Float - Id - Idci - Image - Int - Itemref - Keywords - Langid - Longtext - Longtext_counter - Multilang - Multipart - Name - Namedset - Pagerange - Recaptcha - Relation - Search - Secret - Set - Storable - Subject - Subobject - Text - Time - Timestamp - Url - Uuid

This field works just like a text field except that

it gives a validation error if it does not appear to be a valid email address
when rendered it is rendered as a mailto: link to the email (unless the render_dont_link property is set).

Same as Idci fields except for:

Name	Default Value	Required	Description	Notes
render_dont_link	`0`	NO	Whether to render the email address as a mailto link.	As for Metadata but actually applicable.

No additional phrases beyond those required for Idci fields.

Email fields are stored in the database as

fieldname VARCHAR(255)

Most basic example.

{
    name => "contact_email",
    type => "email",
}

Do not render the email address as a mailto: link.

{
    name => "user_email",
    type => "email",
    render_dont_link => 1,
}

@@ Line 1: / Line 1: @@
 {{fieldtypes}}
+== Description ==
+This field works just like a text field except that
+* it gives a validation error if it does not appear to be a valid email address
+* when rendered it is rendered as a <tt>mailto:</tt> link to the email (unless the <tt>render_dont_link</tt> property is set).
 == Inheritance ==
 * [[:Category:EPrints_Metadata_Fields|Metadata Field]]
 ** [[Id field]]
@@ Line 9: / Line 13: @@
 **** [[Email field]]
-== Description ==
+== Additional Properties ==
-This field works just like a text field except that
+Same as [[Idci field#Additional_Properties|Idci fields]] except for:
-* it gives a validation error if it does not appear to be a valid email address
-* when rendered it is rendered as a <tt>mailto:</tt> link to the email (unless the <tt>render_dont_link</tt> property is set).
-== Properties ==
-Same as [[Id field]], except
 {| border="1" cellpadding="3" cellspacing="0"
-| name || default || description
+! Name !! Default Value !! Required || Description || Notes
 |-
-| '''render_dont_link''' || 0 || ''as for [[Metadata]] but actually applicable.''
+| '''render_dont_link''' || <tt>0</tt> || NO || Whether to render the email address as a mailto link. || As for [[Metadata]] but actually applicable.
 |-
 |}
 == Required Phrases ==
-No additional phrases.
+No additional phrases beyond those required for [[Idci field#Required_Phrases|Idci fields]].
 == Database ==