class Poco::Net::MailRecipient

Overview

The recipient of an e-mail message. More…

#include <MailRecipient.h>

class MailRecipient
{
public:
    // enums

    enum RecipientType;

    // construction

    MailRecipient();
    MailRecipient(const MailRecipient& recipient);

    MailRecipient(
        RecipientType type,
        const std::string& address
        );

    MailRecipient(
        RecipientType type,
        const std::string& address,
        const std::string& realName
        );

    // methods

    MailRecipient&
    operator=(const MailRecipient& recipient);

    void
    swap(MailRecipient& recipient);

    RecipientType
    getType() const;

    void
    setType(RecipientType type);

    const std::string&
    getAddress() const;

    void
    setAddress(const std::string& address);

    const std::string&
    getRealName() const;

    void
    setRealName(const std::string& realName);
};

Detailed Documentation

The recipient of an e-mail message.

A recipient has a type (primary recipient, carbon-copy recipient, blind-carbon-copy recipient), an e-mail address and an optional real name.

Construction

MailRecipient()

Creates an empty MailRecipient.

MailRecipient(const MailRecipient& recipient)

Creates a MailRecipient by copying another one.

MailRecipient(
    RecipientType type,
    const std::string& address
    )

Creates a MailRecipient of the given type.

MailRecipient(
    RecipientType type,
    const std::string& address,
    const std::string& realName
    )

Creates a MailRecipient of the given type.

Methods

MailRecipient&
operator=(const MailRecipient& recipient)

Assigns another recipient.

void
swap(MailRecipient& recipient)

Exchanges the content of two recipients.

RecipientType
getType() const

Returns the type of the recipient.

void
setType(RecipientType type)

Sets the type of the recipient.

const std::string&
getAddress() const

Returns the address of the recipient.

void
setAddress(const std::string& address)

Sets the address of the recipient.

const std::string&
getRealName() const

Returns the real name of the recipient.

void
setRealName(const std::string& realName)

Sets the real name of the recipient.