MailDraft Class Reference

#include "Mail.h"

Public Member Functions
	MailDraft (uint16 mailTemplateId, bool need_items=true)
	MailDraft (std::string subject, std::string body)
uint16	GetMailTemplateId () const
std::string const &	GetSubject () const
uint32	GetMoney () const
uint32	GetCOD () const
std::string const &	GetBody () const
MailDraft &	AddItem (Item *item)
MailDraft &	AddMoney (uint32 money)
MailDraft &	AddCOD (uint32 COD)
void	SendReturnToSender (uint32 sender_acc, ObjectGuid::LowType sender_guid, ObjectGuid::LowType receiver_guid, CharacterDatabaseTransaction trans)
void	SendMailTo (CharacterDatabaseTransaction trans, MailReceiver const &receiver, MailSender const &sender, MailCheckMask checked=MAIL_CHECK_MASK_NONE, uint32 deliver_delay=0, uint32 custom_expiration=0, bool deleteMailItemsFromDB=false, bool sendMail=true)

Private Types
typedef std::map< ObjectGuid, Item * >	MailItemMap

Private Member Functions
void	deleteIncludedItems (CharacterDatabaseTransaction trans, bool inDB=false)
void	prepareItems (Player *receiver, CharacterDatabaseTransaction trans)

Private Attributes
uint16	m_mailTemplateId
bool	m_mailTemplateItemsNeed
std::string	m_subject
std::string	m_body
MailItemMap	m_items
uint32	m_money
uint32	m_COD

Detailed Description

Member Typedef Documentation

MailItemMap

typedef std::map<ObjectGuid, Item*> MailDraft::MailItemMap

private

Constructor & Destructor Documentation

MailDraft() [1/2]

MailDraft::MailDraft ( uint16  mailTemplateId, bool  need_items = true  )

inlineexplicit

        : m_mailTemplateId(mailTemplateId), m_mailTemplateItemsNeed(need_items), m_money(0), m_COD(0)
    {}

MailDraft() [2/2]

MailDraft::MailDraft ( std::string  subject, std::string  body  )

inline

        : m_mailTemplateId(0), m_mailTemplateItemsNeed(false), m_subject(std::move(subject)), m_body(std::move(body)), m_money(0), m_COD(0) {}

Member Function Documentation

AddCOD()

MailDraft & MailDraft::AddCOD ( uint32  COD )

inline

{ m_COD = COD; return *this; }

References m_COD.

Referenced by WorldSession::HandleSendMail().

AddItem()

MailDraft & MailDraft::AddItem

(

Item *

item

)

{
    m_items[item->GetGUID()] = item;
    return *this;
}

References Object::GetGUID(), and m_items.

Referenced by Player::_LoadInventory(), Player::AutoUnequipOffhandIfNeed(), AchievementMgr::CompletedAchievement(), Player::DeleteFromDB(), WorldSession::HandleAuctionRemoveItem(), item_commandscript::HandleItemRefundCommand(), item_commandscript::HandleItemRestoreCommand(), mail_commandscript::HandleMailReturnCommand(), WorldSession::HandleMailReturnToSender(), quest_commandscript::HandleQuestComplete(), quest_commandscript::HandleQuestReward(), spell_gen_spirit_of_competition_participant::HandleScript(), spell_gen_spirit_of_competition_winner::HandleScript(), send_commandscript::HandleSendItemsCommand(), WorldSession::HandleSendMail(), prepareItems(), AuctionHouseMgr::SendAuctionExpiredMail(), AuctionHouseMgr::SendAuctionWonMail(), Player::SendItemRetrievalMail(), Player::SendItemRetrievalMail(), WorldState::SendScourgeInvasionMail(), and ServerMailMgr::SendServerMail().

AddMoney()

MailDraft & MailDraft::AddMoney ( uint32  money )

inline

{ m_money = money; return *this; }

References m_money.

Referenced by Player::DeleteFromDB(), mail_commandscript::HandleMailReturnCommand(), WorldSession::HandleMailReturnToSender(), WorldSession::HandleMailTakeItem(), WorldSession::HandleSendMail(), send_commandscript::HandleSendMoneyCommand(), AuctionHouseMgr::SendAuctionCancelledToBidderMail(), AuctionHouseMgr::SendAuctionOutbiddedMail(), AuctionHouseMgr::SendAuctionSuccessfulMail(), and ServerMailMgr::SendServerMail().

deleteIncludedItems()

void MailDraft::deleteIncludedItems ( CharacterDatabaseTransaction  trans, bool  inDB = false  )

private

{
    for (MailItemMap::iterator mailItemIter = m_items.begin(); mailItemIter != m_items.end(); ++mailItemIter)
    {
        Item* item = mailItemIter->second;
 
        if (inDB)
        {
            CharacterDatabasePreparedStatement* stmt = CharacterDatabase.GetPreparedStatement(CHAR_DEL_ITEM_INSTANCE);
            stmt->SetData(0, item->GetGUID().GetCounter());
            trans->Append(stmt);
        }
 
        delete item;
    }
 
    m_items.clear();
}

References CHAR_DEL_ITEM_INSTANCE, CharacterDatabase, ObjectGuid::GetCounter(), Object::GetGUID(), m_items, and PreparedStatementBase::SetData().

Referenced by SendMailTo(), and SendReturnToSender().

GetBody()

std::string const & MailDraft::GetBody ( ) const

inline

{ return m_body; }

References m_body.

Referenced by SendMailTo().

GetCOD()

uint32 MailDraft::GetCOD ( ) const

inline

{ return m_COD; }

References m_COD.

Referenced by SendMailTo().

GetMailTemplateId()

uint16 MailDraft::GetMailTemplateId ( ) const

inline

{ return m_mailTemplateId; }

References m_mailTemplateId.

Referenced by SendMailTo().

GetMoney()

uint32 MailDraft::GetMoney ( ) const

inline

{ return m_money; }

References m_money.

Referenced by SendMailTo().

GetSubject()

std::string const & MailDraft::GetSubject ( ) const

inline

{ return m_subject; }

References m_subject.

Referenced by SendMailTo().

prepareItems()

void MailDraft::prepareItems ( Player *  receiver, CharacterDatabaseTransaction  trans  )

private

{
    if (!m_mailTemplateId || !m_mailTemplateItemsNeed)
        return;
 
    m_mailTemplateItemsNeed = false;
 
    // The mail sent after turning in the quest The Wrath of Neptulon contains 100g
    // Only quest in the game up to BFA which sends raw gold through mail. So would just be overkill to introduce a new column in the database.
    if (m_mailTemplateId == 123)
    {
        m_money = 1000000;
    }
 
    Loot mailLoot;
 
    // can be empty
    mailLoot.FillLoot(m_mailTemplateId, LootTemplates_Mail, receiver, true, true);
 
    uint32 max_slot = mailLoot.GetMaxSlotInLootFor(receiver);
    for (uint32 i = 0; m_items.size() < MAX_MAIL_ITEMS && i < max_slot; ++i)
    {
        if (LootItem* lootitem = mailLoot.LootItemInSlot(i, receiver))
        {
            if (Item* item = Item::CreateItem(lootitem->itemid, lootitem->count, receiver))
            {
                item->SaveToDB(trans);                           // save for prevent lost at next mail load, if send fail then item will deleted
                AddItem(item);
            }
        }
    }
}

References AddItem(), Item::CreateItem(), Loot::FillLoot(), Loot::GetMaxSlotInLootFor(), Loot::LootItemInSlot(), LootTemplates_Mail, m_items, m_mailTemplateId, m_mailTemplateItemsNeed, m_money, and MAX_MAIL_ITEMS.

Referenced by SendMailTo().

SendMailTo()

void MailDraft::SendMailTo	(	CharacterDatabaseTransaction	trans,
		MailReceiver const &	receiver,
		MailSender const &	sender,
		MailCheckMask	checked = MAIL_CHECK_MASK_NONE,
		uint32	deliver_delay = 0,
		uint32	custom_expiration = 0,
		bool	deleteMailItemsFromDB = false,
		bool	sendMail = true
	)

{
    sScriptMgr->OnBeforeMailDraftSendMailTo(this, receiver, sender, checked, deliver_delay, custom_expiration, deleteMailItemsFromDB, sendMail);
 
    if (deleteMailItemsFromDB) // can be changed in the hook
        deleteIncludedItems(trans, true);
 
    if (!sendMail) // can be changed in the hook
        return;
 
    Player* pReceiver = receiver.GetPlayer();               // can be nullptr
 
    if (pReceiver)
        prepareItems(pReceiver, trans);                            // generate mail template items
 
    // Callers that only know the receiver's guid must still reach an online receiver's in-memory
    // mailbox, otherwise the mail is written to the database only and stays invisible (and
    // unannounced) until that character relogs
    if (!pReceiver)
        pReceiver = ObjectAccessor::FindConnectedPlayer(ObjectGuid::Create<HighGuid::Player>(receiver.GetPlayerGUIDLow()));
 
    uint32 mailId = sObjectMgr->GenerateMailID();
 
    time_t deliver_time = GameTime::GetGameTime().count() + deliver_delay;
 
    //expire time if COD 3 days, if no COD 30 days, if auction sale pending 1 hour
    uint32 expire_delay;
 
    // auction mail without any items and money
    if (sender.GetMailMessageType() == MAIL_AUCTION && m_items.empty() && !m_money)
        expire_delay = sWorld->getIntConfig(CONFIG_MAIL_DELIVERY_DELAY);
    // mail from battlemaster (rewardmarks) should last only one day
    else if (sender.GetMailMessageType() == MAIL_CREATURE && sBattlegroundMgr->GetBattleMasterBG(sender.GetSenderId()) != BATTLEGROUND_TYPE_NONE)
        expire_delay = DAY;
    // default case: expire time if COD 3 days, if no COD 30 days (or 90 days if sender is a game master)
    else if (m_COD)
        expire_delay = 3 * DAY;
    else if (custom_expiration > 0)
        expire_delay = custom_expiration * DAY;
    else
    {
        Player* pSender = ObjectAccessor::FindPlayerByLowGUID(sender.GetSenderId());
        expire_delay = pSender && pSender->GetSession()->GetSecurity() ? 90 * DAY : 30 * DAY;
    }
 
    time_t expire_time = deliver_time + expire_delay;
 
    // Add to DB
    uint8 index = 0;
    CharacterDatabasePreparedStatement* stmt = CharacterDatabase.GetPreparedStatement(CHAR_INS_MAIL);
    stmt->SetData(  index, mailId);
    stmt->SetData(++index, uint8(sender.GetMailMessageType()));
    stmt->SetData(++index, int8(sender.GetStationery()));
    stmt->SetData(++index, GetMailTemplateId());
    stmt->SetData(++index, sender.GetSenderId());
    stmt->SetData(++index, receiver.GetPlayerGUIDLow());
    stmt->SetData(++index, GetSubject());
    stmt->SetData(++index, GetBody());
    stmt->SetData(++index, !m_items.empty());
    stmt->SetData(++index, uint32(expire_time));
    stmt->SetData(++index, uint32(deliver_time));
    stmt->SetData(++index, m_money);
    stmt->SetData(++index, m_COD);
    stmt->SetData(++index, uint8(checked));
    trans->Append(stmt);
 
    for (MailItemMap::const_iterator mailItemIter = m_items.begin(); mailItemIter != m_items.end(); ++mailItemIter)
    {
        stmt = CharacterDatabase.GetPreparedStatement(CHAR_INS_MAIL_ITEM);
        stmt->SetData(0, mailId);
        stmt->SetData(1, mailItemIter->second->GetGUID().GetCounter());
        stmt->SetData(2, receiver.GetPlayerGUIDLow());
        trans->Append(stmt);
    }
 
    sMailMgr->OnMailSent(receiver.GetPlayerGUIDLow());
 
    // For online receiver update in game mail status and data
    if (pReceiver)
    {
        Mail* m = new Mail;
        m->messageID = mailId;
        m->mailTemplateId = GetMailTemplateId();
        m->subject = GetSubject();
        m->body = GetBody();
        m->money = GetMoney();
        m->COD = GetCOD();
 
        for (MailItemMap::const_iterator mailItemIter = m_items.begin(); mailItemIter != m_items.end(); ++mailItemIter)
        {
            Item* item = mailItemIter->second;
            m->AddItem(item->GetGUID().GetCounter(), item->GetEntry());
        }
 
        m->messageType = sender.GetMailMessageType();
        m->stationery = sender.GetStationery();
        m->sender = sender.GetSenderId();
        m->receiver = receiver.GetPlayerGUIDLow();
        m->expire_time = expire_time;
        m->deliver_time = deliver_time;
        m->checked = checked;
        m->state = MAIL_STATE_UNCHANGED;
 
        pReceiver->AddMail(m);                           // to insert new mail to beginning of maillist
 
        if (!m_items.empty())
        {
            for (MailItemMap::iterator mailItemIter = m_items.begin(); mailItemIter != m_items.end(); ++mailItemIter)
            {
                pReceiver->AddMItem(mailItemIter->second);
            }
 
            // The receiver owns the items now, so drop them from the draft without deleting them.
            // The offline path below does the same through deleteIncludedItems, and a draft reused
            // for another receiver must not attach them a second time
            m_items.clear();
        }
 
        // Announce last: the notification may push the inbox, which has to contain this mail already
        pReceiver->AddNewMailDeliverTime(deliver_time);
    }
    else if (!m_items.empty())
    {
        deleteIncludedItems(CharacterDatabaseTransaction(nullptr));
    }
}

References Mail::AddItem(), Player::AddMail(), Player::AddMItem(), Player::AddNewMailDeliverTime(), BATTLEGROUND_TYPE_NONE, Mail::body, CHAR_INS_MAIL, CHAR_INS_MAIL_ITEM, CharacterDatabase, Mail::checked, Mail::COD, CONFIG_MAIL_DELIVERY_DELAY, DAY, deleteIncludedItems(), Mail::deliver_time, Mail::expire_time, ObjectAccessor::FindConnectedPlayer(), ObjectAccessor::FindPlayerByLowGUID(), GetBody(), GetCOD(), ObjectGuid::GetCounter(), Object::GetEntry(), GameTime::GetGameTime(), Object::GetGUID(), MailSender::GetMailMessageType(), GetMailTemplateId(), GetMoney(), MailReceiver::GetPlayer(), MailReceiver::GetPlayerGUIDLow(), WorldSession::GetSecurity(), MailSender::GetSenderId(), Player::GetSession(), MailSender::GetStationery(), GetSubject(), m_COD, m_items, m_money, MAIL_AUCTION, MAIL_CREATURE, MAIL_STATE_UNCHANGED, Mail::mailTemplateId, Mail::messageID, Mail::messageType, Mail::money, prepareItems(), Mail::receiver, sBattlegroundMgr, Mail::sender, PreparedStatementBase::SetData(), sMailMgr, sObjectMgr, sScriptMgr, Mail::state, Mail::stationery, Mail::subject, and sWorld.

Referenced by Player::_LoadBrewOfTheMonth(), Player::_LoadInventory(), Player::AutoUnequipOffhandIfNeed(), AchievementMgr::CompletedAchievement(), Player::GiveLevel(), WorldSession::HandleAuctionRemoveItem(), item_commandscript::HandleItemRefundCommand(), item_commandscript::HandleItemRestoreCommand(), WorldSession::HandleMailTakeItem(), quest_commandscript::HandleQuestComplete(), quest_commandscript::HandleQuestReward(), spell_gen_spirit_of_competition_participant::HandleScript(), spell_gen_spirit_of_competition_winner::HandleScript(), send_commandscript::HandleSendItemsCommand(), WorldSession::HandleSendMail(), send_commandscript::HandleSendMailCommand(), send_commandscript::HandleSendMoneyCommand(), CalendarMgr::RemoveEvent(), Player::RewardQuest(), AuctionHouseMgr::SendAuctionCancelledToBidderMail(), AuctionHouseMgr::SendAuctionExpiredMail(), AuctionHouseMgr::SendAuctionOutbiddedMail(), AuctionHouseMgr::SendAuctionSalePendingMail(), AuctionHouseMgr::SendAuctionSuccessfulMail(), AuctionHouseMgr::SendAuctionWonMail(), Player::SendItemRetrievalMail(), Player::SendItemRetrievalMail(), npc_minigob_manabonk::SendMailToPlayer(), SendReturnToSender(), WorldState::SendScourgeInvasionMail(), and ServerMailMgr::SendServerMail().

SendReturnToSender()

void MailDraft::SendReturnToSender	(	uint32	sender_acc,
		ObjectGuid::LowType	sender_guid,
		ObjectGuid::LowType	receiver_guid,
		CharacterDatabaseTransaction	trans
	)

{
    Player* receiver = ObjectAccessor::FindPlayerByLowGUID(receiver_guid);
 
    if (!receiver && !sCharacterCache->GetCharacterAccountIdByGuid(ObjectGuid(HighGuid::Player, receiver_guid)))
    {
        deleteIncludedItems(trans, true);
        return;
    }
 
    if (!m_items.empty())
    {
        // if item send to character at another account, then apply item delivery delay
        //needItemDelay = sender_acc != rc_account;
 
        // set owner to new receiver (to prevent delete item with sender char deleting)
        for (MailItemMap::iterator mailItemIter = m_items.begin(); mailItemIter != m_items.end(); ++mailItemIter)
        {
            Item* item = mailItemIter->second;
            item->SaveToDB(trans);                      // item not in inventory and can be save standalone
            // owner in data will set at mail receive and item extracting
            CharacterDatabasePreparedStatement* stmt = CharacterDatabase.GetPreparedStatement(CHAR_UPD_ITEM_OWNER);
            stmt->SetData(0, receiver_guid);
            stmt->SetData(1, item->GetGUID().GetCounter());
            trans->Append(stmt);
        }
    }
 
    // xinef: WowWiki: "Return mail arrives immediately."
 
    // will delete item or place to receiver mail list
    SendMailTo(trans, MailReceiver(receiver, receiver_guid), MailSender(MAIL_NORMAL, sender_guid), MAIL_CHECK_MASK_RETURNED, 0);
}

References CHAR_UPD_ITEM_OWNER, CharacterDatabase, deleteIncludedItems(), ObjectAccessor::FindPlayerByLowGUID(), ObjectGuid::GetCounter(), Object::GetGUID(), m_items, MAIL_CHECK_MASK_RETURNED, MAIL_NORMAL, Player, Item::SaveToDB(), sCharacterCache, SendMailTo(), and PreparedStatementBase::SetData().

Referenced by Player::DeleteFromDB(), mail_commandscript::HandleMailReturnCommand(), and WorldSession::HandleMailReturnToSender().

Member Data Documentation

m_body

std::string MailDraft::m_body

private

Referenced by GetBody().

m_COD

uint32 MailDraft::m_COD

private

Referenced by AddCOD(), GetCOD(), and SendMailTo().

m_items

MailItemMap MailDraft::m_items

private

Referenced by AddItem(), deleteIncludedItems(), prepareItems(), SendMailTo(), and SendReturnToSender().

m_mailTemplateId

uint16 MailDraft::m_mailTemplateId

private

Referenced by GetMailTemplateId(), and prepareItems().

m_mailTemplateItemsNeed

bool MailDraft::m_mailTemplateItemsNeed

private

Referenced by prepareItems().

m_money

uint32 MailDraft::m_money

private

Referenced by AddMoney(), GetMoney(), prepareItems(), and SendMailTo().

m_subject

std::string MailDraft::m_subject

private

Referenced by GetSubject().

---

The documentation for this class was generated from the following files:

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