vCardMail - Instructions

1 - Introduction

The vCardMail.pl script is based on Matthew M. Wright's FormMail.pl script.

Those who are not familiar with FormMail.pl should start by reading the Readme file included in this package as the vCardMail.pl script retains all the features and the syntax found in FormMail.pl

It adds the following feature:

2 - About vCard

A vCard will be attached to the e-mail message sent to the specified user. The attachment is a file named "vcard.vcf" which complies with the specification version 2.1 written by the versit Consortium.

3 - Syntax

On a HTML form already formatted after the FormMail  syntax, a vCard field can be added as follows:

<INPUT name="v_NAME_LAST::LastName" type=text size=32 maxlength=64 value="">

The vCard field is v_NAME_LAST, the regular expression being LastName.

The general syntax in the name component is:

                name = [VcardField::]RegularExpression

Notes:

  1. The vCard field is optional
  2. The vCard field is separated from the regular expression with the :: sequence.
  3. When a vCard field is present, the regular expression can be omitted. In this case, the regular name will be the vCard field value.
  4. A sample HTML form -- see http://www.vcardprocessor.com/vcardform00.htm -- is given as an example how to implement these new fields.

4 - List of the vCard fields

4.1 Identification and naming of the individual

v_NAME_TITLE Used for salutation as Mr., Miss, etc.
v_NAME_FIRST First (or given) name
v_NAME_MIDDLE Middle Name
v_NAME_LAST Last (or family) name
v_NAME_SUFFIX Suffix as the 'Jr.' in John Smith Jr.
v_NAME_FORMATTED Name to be displayed (example: John P. Smith)
v_BIRTHDAY_YEAR

v_BIRTHDAY_MONTH

v_BIRTHDAY_DAY

 Date of birth: year (4 digits); month (1 or 2 digits); day (1 or 2 digits).

4.2 Identification and naming of a business

v_ORGANIZATION_NAME Business name
v_ORGANIZATION_TITLE Job title based on the X.520 title attribute (example: V.P., Research and development)
v_ORGANIZATION_JOB Occupation based on the X.520 business category explanatory attribute (example 1: Programmer; example 2: Executive)
v_ORGANIZATION_DEPARTMENT Business division or unit (example 1: Sales division; example 2: Marketing)

4.3 Address properties

4.3.1 Individual address

v_HOME_ADDRESS1 Street address line 1
v_HOME_ADDRESS2 Street address line 2
v_HOME_POSTALBOX P.O. box
v_HOME_CITY City
v_HOME_REGION Region, province or state
v_HOME_POSTALCODE Postal code or zip code
v_HOME_COUNTRY Country
v_HOME_ADDRESS_LABEL(*) Formatted address in a single field

4.3.2 Business address

v_ORGANIZATION_ADDRESS1 Street address line 1
v_ORGANIZATION_ADDRESS2 Street address line 2
v_ORGANIZATION_POSTALBOX P.O. box
v_ORGANIZATION_CITY City
v_ORGANIZATION_REGION Region, province or state
v_ORGANIZATION_POSTALCODE Postal code or zip code
v_ORGANIZATION_COUNTRY Country
v_ORGANIZATION_LABEL(*) Formatted address in a single field

4.3.3 Postal address (a postal delivery address)

v_POSTAL_ADDRESS1 Street address line 1
v_POSTAL_ADDRESS2 Street address line 2
v_POSTAL_POSTALBOX P.O. box
v_POSTAL_CITY City
v_POSTAL_REGION Region, province or state
v_POSTAL_POSTALCODE Postal code or zip code
v_POSTAL_COUNTRY Country
v_POSTAL_LABEL(*) Formatted address in a single field

4.4 Telecommunication properties

4.4.1 Individual

v_HOME_PHONE phone number
v_HOME_EMAIL email address
v_HOME_FAX fax number
v_HOME_WEB web page

4.4.2 Business

v_ORGANIZATION_PHONE phone number
v_ORGANIZATION_EMAIL email address
v_ORGANIZATION_FAX fax number
v_ORGANIZATION_WEB web site
v_ORGANIZATION_TELEX telex

4.4.3 Misc.

v_MOBILE cellular phone number
v_CARPHONE car phone number
v_PAGER pager number
v_MSG(*) message box number
v_ISDN ISDN number
v_VIDEO(*) video-phone number
v_BBS(*) Bulletin board service number
v_MODEM(*) Modem number
v_TIME_ZONE(*) Time zone as described in ISO 8601 specs.(example 1: Easten Standard Time uses the following format: -0500; example 2: Pacific Standard Time uses the following format: -08:00

4.5 Misc. fields

v_NOTE Supplemental information or comment associated with the vCard. (example: This facsimile machine is operational 0830 to 1715 hours, Monday through Friday.)
v_GEOGRAPHIC_POSITION(*) Global positioning of the vCard object. Indicates the longitude and latitude (example: 37.24,-17.87)

 (*) Field is usually not recognized in popular email clients.