\WP_Buoy_SMS_Email_Bridge

register()

register() 

Registers bridge to WordPress API.

run()

run(integer  $post_id) 

Performs a runtime check of an email address for SMS messages.

This method is called by the WP-Cron system to perform a check of an given team's SMS/txt email account.

Parameters

scheduleNext()

scheduleNext(integer  $post_id, integer  $backoff_step) 

Schedules the next run for the given team.

This method uses an adaptive recheck algorithm similar to TCP's adaptive retransmission timer.

Parameters

unscheduleNext()

unscheduleNext(integer  $post_id) 

Unschedules the next run of the bridge for the given team post.

Parameters

connectImap()

connectImap(\WP_Post  $wp_post) : \Horde_Imap_Client_Socket

Connects to an IMAP server with the settings from a given post.

Parameters

Returns

getNextRunTime()

getNextRunTime(integer  $backoff_step) : integer

Determines when the next run should be.

This is implemented by providing a "back-off timer" value as a counter beginning from 0. When 0 is passed, the back-off value is equal to the time step. Otherwise, the counter is multiplied by a multiplier (usually 2).

This creates the following situation when the time step is 30 seconds and the multiplier value is 2:

Run number 1, back-off counter 0, next run in 30 seconds
Run number 2, back-off counter 1, next run in 1 minute
Run number 3, back-off counter 2, next run in 2 minutes
Run number 4, back-off counter 4, next run in 4 minutes
Run number 5, back-off counter 8, next run in 8 minutes

Total elapsed time for five runs is 15 minutes and 30 seconds. When message activity is detected, we reset the counter to 0.

This algorithm helps ensure we don't overload the remote server but still lets us detect the presence and then forward messages relatively quickly when an active conversation is taking place.

The algorithm above is similar to TCP's adaptive retransmission algorithm. (Research that algorithm for more insight on this.)

Parameters

Returns

forward()

forward(\WP_Buoy_SMS  $SMS, string  $text, array<mixed,\WP_Buoy_User>  $recipients, \WP_Buoy_User  $sender, array<mixed,string>  $headers = array()) 

Forwards a text message to a set of recipients.

Parameters