Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail

Package s2Member\Email_Configs

s2member\includes\classes\email-configs.inc.php at line #28

Class c_ws_plugin__s2member_email_configs

c_ws_plugin__s2member_email_configs

public class c_ws_plugin__s2member_email_configs

Email configurations for s2Member.

Since:

3.5


( 9 Methods )
Method Summary
public static str

_email_config_email(str $email)

A sort of callback function that applies the email Filter.

public static str

_email_config_name(str $name)

A sort of callback function that applies the name Filter.

public static null

email_config()

Modifies email From: "Name" .

public static null

email_config_release(bool $all)

Releases Filters that modify the email From: "Name" .

public static bool

email_config_status(bool $any)

Checks the status of Filters being applied to the email From: "Name" .

public static array

email_filter(array $array)

Filters email addresses passed to wp_mail().

public static str

ms_nice_email_roles(str $message)

Converts primitive Role names in emails sent by WordPress®.

public static bool

new_user_notification(str|int $user_id, str $user_pass, array $notify, str $user_email)

Handles new User/Member notifications.

public static bool

reset_pass_resend_new_user_notification(str|int $user_id, str $user_pass, array $notify, str $user_email)

Resets a User/Member password and resends the New User Notification email message (to the User/Member only).

( 9 Methods )
Method Detail

s2member\includes\classes\email-configs.inc.php at line #64

_email_config_email()

public static str _email_config_email(str $email)

A sort of callback function that applies the email Filter.

Since:

3.5

Attaches-to:

add_filter("wp_mail_from");

Parameters:

str $email - Expects the email address to be passed in by the Filter.

Returns:

str - s2Member-configured email address.

[ back to top ]

s2member\includes\classes\email-configs.inc.php at line #81

_email_config_name()

public static str _email_config_name(str $name)

A sort of callback function that applies the name Filter.

Since:

3.5

Attaches-to:

add_filter("wp_mail_from_name");

Parameters:

str $name - Expects the name to be passed in by the Filter.

Returns:

str - s2Member-configured name.

[ back to top ]

s2member\includes\classes\email-configs.inc.php at line #40

email_config()

public static null email_config()

Modifies email From: "Name"

.

These Filters are only needed during registration.

Since:

3.5

Returns:

null

[ back to top ]

s2member\includes\classes\email-configs.inc.php at line #117

email_config_release()

public static null email_config_release(bool $all)

Releases Filters that modify the email From: "Name"

.

Since:

3.5

Parameters:

bool $all - Optional. Defaults to false. If true, remove ALL Filters, not just those applied by s2Member.

Returns:

null

[ back to top ]

s2member\includes\classes\email-configs.inc.php at line #96

email_config_status()

public static bool email_config_status(bool $any)

Checks the status of Filters being applied to the email From: "Name"

.

Since:

3.5

Parameters:

bool $any - Optional. Defaults to false. If true, return true if ANY Filters are being applied, not just those applied by s2Member.

Returns:

bool - True if Filters are being applied, else false.

[ back to top ]

s2member\includes\classes\email-configs.inc.php at line #166

email_filter()

public static array email_filter(array $array)

Filters email addresses passed to wp_mail().

Since:

3.5

Attaches-to:

add_filter("wp_mail");

Uses:

s2Member\Utilitiesc_ws_plugin__s2member_utils_strings::parse_emails()

Parameters:

array $array - Expects an array passed through by the Filter.

Returns:

array - Returns the array passed through by the Filter.

[ back to top ]

s2member\includes\classes\email-configs.inc.php at line #144

ms_nice_email_roles()

public static str ms_nice_email_roles(str $message)

Converts primitive Role names in emails sent by WordPress®.

Only necessary with this particular email: wpmu_signup_user_notification_email.

Since:

3.5

Attaches-to:

add_filter("wpmu_signup_user_notification_email");

Parameters:

str $message - Expects the message string to be passed in by the Filter.

Returns:

str - Message after having been Filtered by s2Member.

[ back to top ]

s2member\includes\classes\email-configs.inc.php at line #219

new_user_notification()

public static bool new_user_notification(str|int $user_id, str $user_pass, array $notify, str $user_email)

Handles new User/Member notifications.

Since:

110707

Parameters:

str|int $user_id - A numeric WordPress® User ID.

str $user_pass - Optional. A plain text version of the User's password. If omitted, only the administrative notification will be sent.

array $notify - An array of directives. Must be non-empty, with at least one of these values user,admin.

str $user_email - Optional. This defaults to the user's currently configured email address.

Returns:

bool - True if all required parameters are supplied, else false.

[ back to top ]

s2member\includes\classes\email-configs.inc.php at line #190

reset_pass_resend_new_user_notification()

public static bool reset_pass_resend_new_user_notification(str|int $user_id, str $user_pass, array $notify, str $user_email)

Resets a User/Member password and resends the New User Notification email message (to the User/Member only).

Since:

110707

Parameters:

str|int $user_id - A numeric WordPress® User ID.

str $user_pass - Optional. A plain text version of the User's password. If omitted, a new password will be generated automatically.

array $notify - An array of directives. Must be non-empty, with at least one of these values user,admin. This defaults to a value of array('user'). We notify the User/Member only (and NOT the administrator).

str $user_email - Optional. This defaults to the user's currently configured email address.

Returns:

bool - True if all required parameters are supplied, else false.

[ back to top ]

Source Code Documentation


Field Summary | Method Summary | Field Detail | Method Detail