Difference between revisions of "Email field"

From EPrints Documentation
Jump to: navigation, search
(Properties)
(Required Phrases)
Line 23: Line 23:
  
 
== Required Phrases ==
 
== Required Phrases ==
No additional phrases.
+
No additional phrases beyond those required for [[Idci field#Required_Phrases|Idci fields]].
  
 
== Database ==
 
== Database ==

Revision as of 09:45, 9 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


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 mailto: link to the email (unless the render_dont_link property is set).

Inheritance

Additional Properties

Same as Idci fields except for:

name default description
render_dont_link 0 as for Metadata but actually applicable.

Required Phrases

No additional phrases beyond those required for Idci fields.

Database

Email fields are stored in the database as

fieldname VARCHAR(255)

API

See API page.

Examples

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,
}