KContacts::Email

Search for usage in LXR

KContacts::Email Class Reference

#include <email.h>

Public Types

typedef QVector< EmailList
 
typedef QFlags< TypeFlagType
 
enum  TypeFlag { Unknown = 0, Home = 1, Work = 2, Other = 4 }
 

Properties

QString email
 
bool isPreferred
 
bool isValid
 
Type type
 

Public Member Functions

 Email ()
 
 Email (const Email &other)
 
 Email (const QString &mail)
 
bool isPreferred () const
 
bool isValid () const
 
QString mail () const
 
bool operator!= (const Email &other) const
 
Emailoperator= (const Email &other)
 
bool operator== (const Email &other) const
 
QMap< QString, QStringListparameters () const
 
void setEmail (const QString &mail)
 
void setParameters (const QMap< QString, QStringList > &params)
 
void setPreferred (bool preferred)
 
void setType (Type type)
 
QString toString () const
 
Type type () const
 

Detailed Description

Class that holds a Email for a contact.

Since
4.14.5

Definition at line 27 of file email.h.

Member Typedef Documentation

◆ Type

Stores a combination of TypeFlag values.

Definition at line 66 of file email.h.

Member Enumeration Documentation

◆ TypeFlag

Email types.

See also
Type
Enumerator
Unknown 

No or unknown email type is set.

Home 

Personal email.

Work 

Work email.

Other 

Other email.

Definition at line 56 of file email.h.

Constructor & Destructor Documentation

◆ Email()

Email::Email ( )

Creates an empty email object.

Definition at line 35 of file email.cpp.

Member Function Documentation

◆ isPreferred()

bool KContacts::Email::isPreferred ( ) const

Returns whether this is the preferred email address.

Since
5.12

◆ parameters()

QMap< QString, QStringList > Email::parameters ( ) const
Deprecated:
Since 5.88 for lack of usage

Definition at line 91 of file email.cpp.

◆ setParameters()

void Email::setParameters ( const QMap< QString, QStringList > &  params)
Deprecated:
Since 5.88 for lack of usage

Definition at line 84 of file email.cpp.

◆ setPreferred()

void Email::setPreferred ( bool  preferred)

Sets that this is the preferred email address.

Since
5.12

Definition at line 195 of file email.cpp.

◆ setType()

void Email::setType ( Type  type)

Sets the email type.

Since
5.12

Definition at line 152 of file email.cpp.

◆ type()

Type KContacts::Email::type ( ) const

Returns the type of the email.

Since
5.12

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Nov 28 2023 04:12:37 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.