# kabc Library API Documentation

Overview | Class Hierarchy | Classes | Classes (annotated) | Members | Namespaces | Source Files

# KABC::LDIFConverter Namespace Reference

A set of functions to convert a string with LDIF information to addressees and vice versa. More...

## Functions

KABC_EXPORT bool | LDIFToAddressee (const QString &str, AddresseeList &addrList, QDateTime dt=QDateTime::currentDateTime())
KABC_EXPORT bool | addresseeToLDIF (const AddresseeList &addrList, QString &str)
KABC_EXPORT bool | addresseeToLDIF (const Addressee &addr, QString &str)
KABC_EXPORT QString | makeLDIFfieldString (QString field, QString value, bool allowEncode=true) KDE_DEPRECATED
KABC_EXPORT bool | parseSingleLine (Addressee &a, Address &homeAddr, Address &workAddr, QString &line)
KABC_EXPORT bool | splitLine (QString &line, QString &fieldname, QString &value)
KABC_EXPORT bool | evaluatePair (Addressee &a, Address &homeAddr, Address &workAddr, QString &fieldname, QString &value)

## Detailed Description

A set of functions to convert a string with LDIF information to addressees and vice versa.

It is useful for addressbook import- and exportfilters and might be used to read and write Mozilla and Netscape addresssbooks.

## Function Documentation

KABC_EXPORT bool LDIFToAddressee | ( | const QString & | str,
|  | AddresseeList & | addrList,
|  | QDateTime | dt = `QDateTime::currentDateTime()`
| ) |

Converts a LDIF string to a list of addressees.

Parameters:

  | str | The vcard string.
  | addrList | The addresseelist.
  | dt | The date & time value of the last modification (e.g. file modification time).

Since:
  3.2

KABC_EXPORT bool addresseeToLDIF | ( | const AddresseeList & | addrList,
|  | QString & | str
| ) |

Converts a list of addressees to a LDIF string.

Parameters:

  | addrList | The addresseelist.
  | str | The LDIF string.

Since:
  3.2

KABC_EXPORT bool addresseeToLDIF | ( | const Addressee & | addr,
|  | QString & | str
| ) |

Converts an addressee to a LDIF string.

Parameters:

  | addr | The addressee.
  | str | The LDIF string.

Since:
  3.2

KABC_EXPORT QString makeLDIFfieldString | ( | QString | field,
|  | QString | value,
|  | bool | allowEncode = `true`
| ) |

Deprecated:
  Obsoleted - please use LDIF::assembleLine() Returns a LDIF compatible string representing a given field/value pair. If necessary, the value parameter will be base64encoded and split into multiple. This function will return an empty string if the given value is empty.

Parameters:

  | field | The LDAP field name or a complete LDIF field string (e.g. "cn" or "cn = %1\n").
  | value | The value for this field.
  | allowEncode | Set to false if you wish no encoding of the value.

Since:
  3.2

KABC_EXPORT bool parseSingleLine | ( | Addressee & | a,
|  | Address & | homeAddr,
|  | Address & | workAddr,
|  | QString & | line
| ) |

| No need for this function anymore - use LDIF::splitLine() + evaluatePair().

KABC_EXPORT bool splitLine | ( | QString & | line,
|  | QString & | fieldname,
|  | QString & | value
| ) |

| No need for this function anymore - use LDIF::splitLine().

This file is part of the documentation for kabc Library Version 3.4.1.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Jun 11 20:31:56 2005 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003