Class Vpim::Vcard::Maker
In: lib/vpim/vcard.rb
Parent: Object

A class to make and make changes to vCards.

It can be used to create completely new vCards using Vcard#make2.

Its is also yielded from Vpim::Vcard#make, in which case it allows a kind of transactional approach to changing vCards, so their values can be validated after any changes have been made.

Examples:

Methods

add_addr   add_email   add_field   add_impp   add_name   add_note   add_photo   add_tel   add_url   add_x_aim   birthday=   copy   delete_if   make   make2   name   nickname=   org=   title=  

Public Class methods

Deprecated, use make2.

If set, the FN field will be set to full_name. Otherwise, FN will be set from the values in name.

Make a vCard.

Yields maker, a Vpim::Vcard::Maker which allows fields to be added to card, and returns card, a Vpim::Vcard.

If card is nil or not provided a new Vpim::Vcard is created and the fields are added to it.

Defaults:

  • vCards must have both an N and an FN field, make2 will fail if there is no N field in the card when your block is finished adding fields.
  • If there is an N field, but no FN field, FN will be set from the information in N, see Vcard::Name#preformatted for more information.
  • vCards must have a VERSION field. If one does not exist when your block is is finished it will be set to 3.0.

Public Instance methods

Add an address field, ADR. address is a Vpim::Vcard::Address.

Add an email field, EMAIL. email is a Vpim::Vcard::Email.

The block is optional, its only necessary if you want to specify the optional attributes.

Add a Field, field.

Add an instant-messaging/point of presence address field, IMPP. The address is a URL, with the syntax depending on the protocol.

Attributes of IMPP are:

  • preferred: true - set if this is the preferred address
  • location: home, work, mobile - location of address
  • purpose: personal,business - purpose of communications

All attributes are optional, and so is the block.

The URL syntaxes for the messaging schemes is fairly complicated, so I don‘t try and build the URLs here, maybe in the future. This forces the user to know the URL for their own address, hopefully not too much of a burden.

IMPP is defined in draft-jennings-impp-vcard-04.txt. It refers to the URI scheme of a number of messaging protocols, but doesn‘t give references to all of them:

  • "xmpp" indicates to use XMPP, draft-saintandre-xmpp-uri-06.txt
  • "irc" or "ircs" indicates to use IRC, draft-butcher-irc-url-04.txt
  • "sip" indicates to use SIP/SIMPLE, RFC 3261
  • "im" or "pres" indicates to use a CPIM or CPP gateway, RFC 3860 and RFC 3859
  • "ymsgr" indicates to use yahoo
  • "msn" might indicate to use Microsoft messenger
  • "aim" indicates to use AOL
add_name(

Alias for name

Add a note field, NOTE. The note String can contain newlines, they will be escaped.

Add a photo field, PHOTO.

Attributes of PHOTO are:

  • image: set to image data to include inline
  • link: set to the URL of the image data
  • type: string identifying the image type, supposed to be an "IANA registered image format",
      or a non-registered image format (usually these start with an x-)
    

An error will be raised if neither image or link is set, or if both image and link is set.

Setting type is optional for a link image, because either the URL, the image file extension, or a HTTP Content-Type may specify the type. If it‘s not a link, setting type is mandatory, though it can be set to an empty string, ’’, if the type is unknown.

TODO - I‘m not sure about this API. I‘m thinking maybe it should be add_photo(image, type), and that I should detect when the image is a URL, and make type mandatory if it wasn‘t a URL.

Add a telephone field, TEL. tel is a Vpim::Vcard::Telephone.

The block is optional, its only necessary if you want to specify the optional attributes.

Add a URL field, URL.

Add an X-AIM account name where xaim is an AIM screen name.

I don‘t know if this is conventional, or supported by anything other than AddressBook.app, but an example is:

  X-AIM;type=HOME;type=pref:exampleaccount

Attributes of X-AIM are:

  • preferred: true - set if this is the preferred address
  • location: home, work, mobile - location of address

All attributes are optional, and so is the block.

Add a birthday field, BDAY.

birthday must be a time or date object.

Warning: It may confuse both humans and software if you add multiple birthdays.

Copy the fields from card into self using add_field. If a block is provided, each Field from card is yielded. The block should return a Field to add, or nil. The Field doesn‘t have to be the one yielded, allowing the field to be copied and modified (see Field#copy) before adding, or not added at all if the block yields nil.

The vCard fields BEGIN and END aren‘t copied, and VERSION, N, and FN are copied only if the card doesn‘t have them already.

Delete line if block yields true.

Set the name fields, N and FN.

Attributes of name are:

  • family: family name
  • given: given name
  • additional: additional names
  • prefix: such as "Ms." or "Dr."
  • suffix: such as "BFA", or "Sensei"

name is a Vcard::Name.

All attributes are optional, though have all names be zero-length strings isn‘t really in the spirit of things. FN‘s value will be set to Vcard::Name#formatted if Vcard::Name#fullname isn‘t given a specific value.

Warning: This is the only mandatory field.

Set the nickname field, NICKNAME.

It can be set to a single String or an Array of String.

Set the org field, ORG.

It can be set to a single String or an Array of String.

Set the title field, TITLE.

It can be set to a single String.

[Validate]