Syntax Overview
NOTE: I have been told that this overview is too lengthy, so if your time is precious, see avieri in 124 words.
An avieri-addressbook entry basically is an email that follows certain rules.
The header needs only one entry: the subject line. It specifies the "nickname" of the person, i.e. the name under which it will be filed. e.g. Bill, Frank, Wife, My Boss, Frank Starling, etc.
The body contains the address entries. Empty lines and lines starting with '#' (without the quotes) are being ignored by avieri-compliant email-clients.
The following elements are allowed in arbitrary sequence:
Name
: indicating the last name. e.g.Name Starling
FirstName
: indicating the first name. e.g.FirstName Frank
Title
: the Title. e.g.Title Ph.D.
Company
: e.g.Company University of Antarctica
- The following elements may be specified more than once:
HomeTel
: Phone number at home. e.g.HomeTel +49 1234 5678901
WorkTel
: Phone number at home. e.g.WorkTel +49 1234 5678901
HomeFax
: Fax number at home. e.g.HomeFax +49 1234 5678901
WorkFax
: Fax number at work. e.g.WorkFax +49 1234 5678901
Mobile
: Mobile Phone number. e.g.Mobile +49 1234 5678901
Email
: eMail Address. e.g.Email frank.starling@example.com
Pager
: Pager number. e.g.Pager +49 1234 5678901
Other
: any other contact form. e.g.Other 123567890
HomeAddress1
: first line of the home address. e.g.HomeAddress1 Beispielstreet 73
HomeAddress2
: second line of the home address. e.g.HomeAddress2 c/o Bill Van Helsing
HomeCity
: city the home address is located. e.g.HomeCity Munich
HomeState
: the state of the home address. e.g.HomeState Bavaria
HomeZipCode
: the zip code. e.g.HomeZipCode 80333
HomeCountry
: the country. e.g.HomeCountry Germany
- The following elements each correspond to the respective "Home" version and are used accordingly:
WorkAddress1
WorkAddress2
WorkCity
WorkState
WorkZipCode
WorkCountry
Category
: the category to sort in this address-entry, this may be specified more than once. e.g.Category friends
Birthday
: the birthday in one of the following formats:yyyymmdd
,dd.mm.yyyy
,mm/dd/yyyy
. e.g.Birthday 29.10.1963
Custom1
: user defineable fields. You can have up to ten of them:Custom1
,Custom2
,Custom3
,Custom4
,Custom5
,Custom6
,Custom7
,Custom8
,Custom9
,Custom0
Additional elements might be added during the following planning stage.
This is an example avieri-addressbook entry in the form of a complete email including headers:
Subject: Starling, Frank
Name Starling
FirstName Frank
Title Ph.D.
Company University of Antarctica
# The order of these entries is not important
# This is a comment
HomeTel +49 1234 5678901
WorkTel +49 1234 5678901
HomeFax +49 1234 5678901
WorkFax +49 1234 5678901
Mobile +49 1234 5678901
Email frank.starling@example.com
Email frank@example.org
Pager +49 1234 5678901
Other 123567890
HomeAddress1 Beispielstreet 73
HomeAddress2 c/o Bill Van Helsing
HomeCity Munich
HomeState Bavaria
HomeZipCode 80333
HomeCountry Germany
WorkAddress1 Institute of Snow Research
WorkAddress2 Dieselstreet 117
WorkCity Snowflakevillage
WorkState Snowflakeshire
WorkZipCode 100
WorkCountry Antarctica
Category friends
Category colleagues
Category Bowlingclub
Birthday 29.10.1963
Custom1 I really like this guy!
For better readability it is recommended to format it this way:
Subject: Starling, Frank
Name Starling
FirstName Frank
Title Ph.D.
Company University of Antarctica
# The order all these entries are listed in, is not important
# This is a comment
HomeTel +49 1234 5678901
WorkTel +49 1234 5678901
HomeFax +49 1234 5678901
WorkFax +49 1234 5678901
Mobile +49 1234 5678901
Email frank.starling@example.com
Email frank@example.org
Pager +49 1234 5678901
Other 123567890
HomeAddress1 Beispielstreet 73
HomeAddress2 c/o Bill Van Helsing
HomeCity Munich
HomeState Bavaria
HomeZipCode 80333
HomeCountry Germany
WorkAddress1 Institute of Snow Research
WorkAddress2 Dieselstreet 117
WorkCity Snowflakevillage
WorkState Snowflakeshire
WorkZipCode 100
WorkCountry Antarctica
Category friends
Category colleagues
Category Bowlingclub
Birthday 29.10.1963
Custom1 I really like this guy!
Avieri in 124 words
- create a folder on your IMAP server called: "addressbook"
- create emails following this example as your addressbook entries:
Subject: Starling, Frank
Name Starling
FirstName Frank
Title Ph.D.
Company University of Antarctica
# The order all these entries are listed in, is not important
# This is a comment
HomeTel +49 1234 5678901
WorkTel +49 1234 5678901
HomeFax +49 1234 5678901
WorkFax +49 1234 5678901
Mobile +49 1234 5678901
Email frank.starling@example.com
Email frank@example.org
Pager +49 1234 5678901
Other 123567890
HomeAddress1 Beispielstreet 73
HomeAddress2 c/o Bill Van Helsing
HomeCity Munich
HomeState Bavaria
HomeZipCode 80333
HomeCountry Germany
WorkAddress1 Institute of Snow Research
WorkAddress2 Dieselstreet 117
WorkCity Snowflakevillage
WorkState Snowflakeshire
WorkZipCode 100
WorkCountry Antarctica
Category friends
Category colleagues
Category Bowlingclub
Birthday 29.10.1963
Custom1 I really like this guy!