Mail Struct Reference

#include "Mail.h"

Public Member Functions
void	AddItem (ObjectGuid::LowType itemGuidLow, uint32 item_template)
bool	RemoveItem (ObjectGuid::LowType item_guid)
bool	HasItems () const
bool	IsSentByPlayer () const
bool	IsSentByGM () const
bool	IsCODPayment () const
bool	IsReturnedMail () const

Public Attributes
uint32	messageID
uint8	messageType
uint8	stationery
uint16	mailTemplateId
uint32	sender
ObjectGuid::LowType	receiver
std::string	subject
std::string	body
std::vector< MailItemInfo >	items
std::vector< uint32 >	removedItems
time_t	expire_time
time_t	deliver_time
uint32	money
uint32	COD
uint32	checked
MailState	state

Detailed Description

Member Function Documentation

AddItem()

void Mail::AddItem ( ObjectGuid::LowType  itemGuidLow, uint32  item_template  )

inline

    {
        MailItemInfo mii;
        mii.item_guid = itemGuidLow;
        mii.item_template = item_template;
        items.push_back(mii);
    }

References MailItemInfo::item_guid, MailItemInfo::item_template, and items.

Referenced by Player::_LoadMailedItem(), and MailDraft::SendMailTo().

HasItems()

bool Mail::HasItems ( ) const

inline

{ return !items.empty(); }

References items.

Referenced by Player::_SaveMail(), and WorldSession::HandleMailReturnToSender().

IsCODPayment()

bool Mail::IsCODPayment ( ) const

inline

{ return checked & MAIL_CHECK_MASK_COD_PAYMENT; }

References checked, and MAIL_CHECK_MASK_COD_PAYMENT.

Referenced by ObjectMgr::ReturnOrDeleteOldMails().

IsReturnedMail()

bool Mail::IsReturnedMail ( ) const

inline

{ return checked & MAIL_CHECK_MASK_RETURNED; }

References checked, and MAIL_CHECK_MASK_RETURNED.

Referenced by ObjectMgr::ReturnOrDeleteOldMails().

IsSentByGM()

bool Mail::IsSentByGM ( ) const

inline

{ return stationery == MAIL_STATIONERY_GM; }

References MAIL_STATIONERY_GM, and stationery.

Referenced by ObjectMgr::ReturnOrDeleteOldMails().

IsSentByPlayer()

bool Mail::IsSentByPlayer ( ) const

inline

{ return messageType == MAIL_NORMAL; }

References MAIL_NORMAL, and messageType.

Referenced by ObjectMgr::ReturnOrDeleteOldMails().

RemoveItem()

bool Mail::RemoveItem ( ObjectGuid::LowType  item_guid )

inline

    {
        for (MailItemInfoVec::iterator itr = items.begin(); itr != items.end(); ++itr)
        {
            if (itr->item_guid == item_guid)
            {
                items.erase(itr);
                return true;
            }
        }
        return false;
    }

References items.

Referenced by WorldSession::HandleMailTakeItem().

Member Data Documentation

body

std::string Mail::body

Referenced by Player::_LoadMail(), WorldSession::HandleMailCreateTextItem(), WorldSession::HandleMailReturnToSender(), and MailDraft::SendMailTo().

checked

uint32 Mail::checked

Referenced by Player::_LoadMail(), Player::_SaveMail(), WorldSession::HandleMailCreateTextItem(), WorldSession::HandleMailMarkAsRead(), IsCODPayment(), IsReturnedMail(), ObjectMgr::ReturnOrDeleteOldMails(), and MailDraft::SendMailTo().

COD

uint32 Mail::COD

Referenced by Player::_LoadMail(), Player::_SaveMail(), WorldSession::HandleMailDelete(), WorldSession::HandleMailReturnToSender(), WorldSession::HandleMailTakeItem(), and MailDraft::SendMailTo().

deliver_time

time_t Mail::deliver_time

Referenced by Player::_LoadMail(), Player::_SaveMail(), WorldSession::HandleMailCreateTextItem(), WorldSession::HandleMailReturnToSender(), WorldSession::HandleMailTakeItem(), WorldSession::HandleMailTakeMoney(), ObjectMgr::ReturnOrDeleteOldMails(), and MailDraft::SendMailTo().

expire_time

time_t Mail::expire_time

Referenced by Player::_LoadMail(), Player::_SaveMail(), ObjectMgr::ReturnOrDeleteOldMails(), and MailDraft::SendMailTo().

items

std::vector<MailItemInfo> Mail::items

Referenced by Player::_SaveMail(), AddItem(), WorldSession::HandleMailReturnToSender(), WorldSession::HandleMailTakeItem(), HasItems(), RemoveItem(), and ObjectMgr::ReturnOrDeleteOldMails().

mailTemplateId

uint16 Mail::mailTemplateId

Referenced by Player::_LoadMail(), WorldSession::HandleMailCreateTextItem(), WorldSession::HandleMailReturnToSender(), ObjectMgr::ReturnOrDeleteOldMails(), and MailDraft::SendMailTo().

messageID

uint32 Mail::messageID

Referenced by Player::_LoadMail(), Player::_SaveMail(), ObjectMgr::ReturnOrDeleteOldMails(), and MailDraft::SendMailTo().

messageType

uint8 Mail::messageType

Referenced by Player::_LoadMail(), WorldSession::HandleMailReturnToSender(), IsSentByPlayer(), ObjectMgr::ReturnOrDeleteOldMails(), and MailDraft::SendMailTo().

money

uint32 Mail::money

Referenced by Player::_LoadMail(), Player::_SaveMail(), WorldSession::HandleMailReturnToSender(), WorldSession::HandleMailTakeMoney(), and MailDraft::SendMailTo().

receiver

ObjectGuid::LowType Mail::receiver

Referenced by Player::_LoadMail(), WorldSession::HandleMailReturnToSender(), WorldSession::HandleMailTakeItem(), ObjectMgr::ReturnOrDeleteOldMails(), and MailDraft::SendMailTo().

removedItems

std::vector<uint32> Mail::removedItems

Referenced by Player::_SaveMail(), and WorldSession::HandleMailTakeItem().

sender

uint32 Mail::sender

Referenced by Player::_LoadMail(), WorldSession::HandleMailCreateTextItem(), WorldSession::HandleMailReturnToSender(), WorldSession::HandleMailTakeItem(), ObjectMgr::ReturnOrDeleteOldMails(), and MailDraft::SendMailTo().

state

MailState Mail::state

Referenced by Player::_LoadMail(), Player::_SaveMail(), WorldSession::HandleMailCreateTextItem(), WorldSession::HandleMailDelete(), WorldSession::HandleMailMarkAsRead(), WorldSession::HandleMailReturnToSender(), WorldSession::HandleMailTakeItem(), WorldSession::HandleMailTakeMoney(), and MailDraft::SendMailTo().

stationery

uint8 Mail::stationery

Referenced by Player::_LoadMail(), IsSentByGM(), ObjectMgr::ReturnOrDeleteOldMails(), and MailDraft::SendMailTo().

subject

std::string Mail::subject

Referenced by Player::_LoadMail(), WorldSession::HandleMailReturnToSender(), WorldSession::HandleMailTakeItem(), and MailDraft::SendMailTo().

---

The documentation for this struct was generated from the following file:

• azerothcore-wotlk/src/server/game/Mails/Mail.h