ESOUI - Problem with guild mail

ESOUI (https://www.esoui.com/forums/index.php)

- AddOn Help/Support (https://www.esoui.com/forums/forumdisplay.php?f=164)

- - Problem with guild mail (https://www.esoui.com/forums/showthread.php?t=4317)

Problem with guild mail

Hey fellow coders,

is there any working solution for sending a mass mail to all members of a guild without getting kicked for spam?

In my large trade guild (500 people), we are sending a news mail to our members from time to time. Using the mail function from TIM it stops after ~70 mails and the game kicks for spam.

Can this be avoided? Maybe with setting a delay between each mail?

Yes, that would probably work. I think MailR uses a 1-second delay by default.

I checked TIMs code and changed the function that processes the mail queue. Here is my solution:

Lua Code:

function tim.sendQueuedMail()
    if tim.mailQueueindex>0 then
        -- EINEN MailQueue-Eintrag senden (pro Aufruf dieser Funktion)
        local mailboxwasopen=tim.MailBoxOpen
        if tim.MailBoxOpen==false then
            RequestOpenMailbox()
        end
        tim.wait4mail=true
        tim.MailInQueue=tim.mailQueue.mTO[tim.mailQueueindex]
        tim.MailInQueueSUB=tim.mailQueue.mSUB[tim.mailQueueindex]
        SendMail(tim.mailQueue.mTO[tim.mailQueueindex], tim.mailQueue.mSUB[tim.mailQueueindex], tim.mailQueue.mTEXT[tim.mailQueueindex])
        if mailboxwasopen==false then
            CloseMailbox()
        end
        tim.mailQueueindex=tim.mailQueueindex-1
    end
end

Lua Code:

function tim.sendQueuedMail()
  if tim.mailQueueindex>0 then
      EVENT_MANAGER:RegisterForUpdate("tim_EVENT_EMAIL", tim.throttleTimerMail, function()
        -- EINEN MailQueue-Eintrag senden (pro Aufruf dieser Funktion)
        local mailboxwasopen=tim.MailBoxOpen
        if tim.MailBoxOpen==false then
          RequestOpenMailbox()
        end
        tim.wait4mail=true
        tim.MailInQueue=tim.mailQueue.mTO[tim.mailQueueindex]
        tim.MailInQueueSUB=tim.mailQueue.mSUB[tim.mailQueueindex]
        SendMail(tim.mailQueue.mTO[tim.mailQueueindex], tim.mailQueue.mSUB[tim.mailQueueindex], tim.mailQueue.mTEXT[tim.mailQueueindex])
        if mailboxwasopen==false then
          CloseMailbox()
        end
        tim.mailQueueindex=tim.mailQueueindex-1
        if tim.mailQueueindex==0 then
          EVENT_MANAGER:UnregisterForUpdate("tim_EVENT_EMAIL")
        end
      end)
    end
end

Is that approach with RegisterForUpdate viable or is there a better way to add a simple delay?

I guess it is viable for the current source code as the function tim.sendQueuedMail() is called several times, once for each new guil member mail?

As an alternative you could delay the call to this function tim.sendQueuedMail(), use zo_callLater(tim.sendQueuedMail(), 500) or something like this.

With other addons I have seen sourc code where the EVENTS (crafting_finished e.g.) was the trigger to call the next process.
Maybe there is an event like "MAIL_HAS_BEEN_SENT" and you could use this one to send the next mail (+ delay in between.

Quote:

Originally Posted by Baertram (Post 19053)

* EVENT_MAIL_SEND_FAILED (*integer* _reason_)
* EVENT_MAIL_SEND_SUCCESS

Thanks for your inputs!

After digging a bit deeper in the code i figured out how TIM handles the mailing. tim.sendQueuedMail() is part of the update callback function (fired from OnUpdate), so one mail from the queue is sent every tick.

TIM uses a custom throttle function to control update ticks for special purposes. I ended up using this function in tim.sendQueuedMail() with my desired delay and it works.

Here is the final code:

Lua Code:

function tim.sendQueuedMail()
  if tim.mailQueueindex>0 then
    if (tim.UpdateThrottle("SendQueuedMail", tim.throttleCountMail) == true) then
      -- EINEN MailQueue-Eintrag senden (pro Aufruf dieser Funktion)
      local mailboxwasopen=tim.MailBoxOpen
      if tim.MailBoxOpen==false then
        RequestOpenMailbox()
      end
      tim.wait4mail=true
      tim.MailInQueue=tim.mailQueue.mTO[tim.mailQueueindex]
      tim.MailInQueueSUB=tim.mailQueue.mSUB[tim.mailQueueindex]
      SendMail(tim.mailQueue.mTO[tim.mailQueueindex], tim.mailQueue.mSUB[tim.mailQueueindex], tim.mailQueue.mTEXT[tim.mailQueueindex])
      if mailboxwasopen==false then
        CloseMailbox()
      end
      tim.mailQueueindex=tim.mailQueueindex-1
    end
  end
end