PHP Class Falcon_Handler_Postmark, Falcon

Inheritance: implements Falcon_Handler
Show file Open project: rmccue/Falcon Class Usage Examples

Protected Properties

Property Type Description
$current_options array For the settings callbacks, we need to hold on to the current options

Public Methods

Method Description
__construct ( $options )
check_inbox ( ) Check the inbox for replies
field_apikey ( )
get_name ( ) : string Get a human-readable name for the handler
handle_post ( )
options_section_header ( ) Output a description for the options
register_option_fields ( string $group, string $section, array $options ) Register handler-specific option fields
send_mail ( $users, Falcon_Message $message )
supports_message_ids ( ) : boolean Specify that Postmark allows custom message IDs
validate_options ( array $input ) : array Validate the options from the submitted form

Protected Methods

Method Description
send_single ( $data )

Method Details

__construct() public method

public __construct ( $options )

check_inbox() public method

Postmark sends POST requests when we receive an email instead
public check_inbox ( )

field_apikey() public static method

public static field_apikey ( )

get_name() public static method

This is used for the handler selector and is shown to the user.
public static get_name ( ) : string
return string

handle_post() public method

public handle_post ( )

options_section_header() public static method

If you have any extra information you want to tell the user, this is probably the best place for it to live.
public static options_section_header ( )

register_option_fields() public static method

Register handler-specific option fields
See also: bbSubscriptions_Handler::register_option_fields
public static register_option_fields ( string $group, string $section, array $options )
$group string Settings group (4th parameter to `add_settings_field`)
$section string Settings section (5th parameter to `add_settings_field`)
$options array Current options

send_mail() public method

public send_mail ( $users, Falcon_Message $message )
$message Falcon_Message

send_single() protected method

protected send_single ( $data )

supports_message_ids() public static method

Postmark lets us set our own message ID, so allow Falcon to operate in Leader Mode.
public static supports_message_ids ( ) : boolean
return boolean

validate_options() public static method

Validate the options from the submitted form
See also: bbSubscriptions_Handler::validate_options
public static validate_options ( array $input ) : array
$input array Raw POSTed data
return array Sanitized POST data

Property Details

$current_options protected static property

For the settings callbacks, we need to hold on to the current options
protected static array $current_options
return array