WPDKMail Class Reference

Inheritance diagram for WPDKMail:

Public Member Functions
	__construct ($mail=null, $post_type= 'page')
	Construct. More...
	send ($to, $subject=false, $from= '', $placeholders=array())
	Send mail. More...
Public Member Functions inherited from WPDKPost
	__construct ($record=null, $post_type= 'page')
	Construct. More...
	delete ()
	Delete. More...
	trash ()
	Set in trash. More...
	untrash ()
	Set in trash. More...
	update ()
	Update. More...
	updateMeta ($args=array())
	Update meta. More...
	metaValue ($meta_key)
	Meta value. More...
	metaValues ($meta_key)
	Meta values. More...
	thumbnail ($size= 'full')
	Get thumbnail image. More...
	imageAttachments ($size= 'full', $index=1)
	Attachment image. More...
	imageContent ()
	image in post content More...
Public Member Functions inherited from WPDKObject
	__className ()
	Returns the class object. More...
	__parentClass ()
	Returns the class object for the receiver’s superclass. More...
	__isClass ($class)
	Brief. More...
	__isSubclassOfClass ($class)
	Return TRUE if the receiving class is a subclass of —or identical to— $class, otherwise FALSE. More...

Data Fields
	$cc = ''
	Carbon copy. More...
	$bcc = ''
	Carbon copy. More...
Data Fields inherited from WPDKPost
const	COLUMN_COMMENT_COUNT = 'comment_count'
const	COLUMN_COMMENT_STATUS = 'comment_status'
const	COLUMN_GUID = 'guid'
const	COLUMN_ID = 'ID'
const	COLUMN_MENU_ORDER = 'menu_order'
const	COLUMN_PINGED = 'pinged'
const	COLUMN_PING_STATUS = 'ping_status'
const	COLUMN_POST_AUTHOR = 'post_author'
const	COLUMN_POST_CONTENT = 'post_content'
const	COLUMN_POST_CONTENT_FILTERED = 'post_content_filtered'
const	COLUMN_POST_DATE = 'post_date'
const	COLUMN_POST_DATE_GMT = 'post_date_gmt'
const	COLUMN_POST_EXCERPT = 'post_excerpt'
const	COLUMN_POST_MIME_TYPE = 'post_mime_type'
const	COLUMN_POST_MODIFIED = 'post_modified'
const	COLUMN_POST_MODIFIED_GMT = 'post_modified_gmt'
const	COLUMN_POST_NAME = 'post_name'
const	COLUMN_POST_PARENT = 'post_parent'
const	COLUMN_POST_PASSWORD = 'post_password'
const	COLUMN_POST_STATUS = 'post_status'
const	COLUMN_POST_TITLE = 'post_title'
const	COLUMN_POST_TYPE = 'post_type'
const	COLUMN_TO_PING = 'to_ping'
	$__version = '1.0.2'
	Version. More...
	$ID
	ID Post. More...
	$comment_count
	Comment count. More...
	$comment_status
	Comment status. More...
	$guid
	GUID. More...
	$menu_order
	Menu order. More...
	$ping_status
	Ping status. More...
	$pinged
	List of pinged urls. More...
	$post_author
	ID author. More...
	$post_category
	Category ID. More...
	$post_content
	Content. More...
	$post_content_filtered
	Content filtered. More...
	$post_date
	Date Post. More...
	$post_date_gmt
	Date post in GMT. More...
	$post_excerpt
	Excerpt. More...
	$post_mime_type
	Mime type. More...
	$post_modified
	Modified date. More...
	$post_modified_gmt
	Modifed date in GMT. More...
	$post_name
	Name. More...
	$post_parent
	Parent post. More...
	$post_password
	Password. More...
	$post_status
	Status. More...
	$post_title
	Title. More...
	$post_type
	Type. More...
	$to_ping
	List ping urls. More...
Data Fields inherited from WPDKObject
	$__version = '1.0.0'
	The version number assigned to the class. More...

Additional Inherited Members
Static Public Member Functions inherited from WPDKPost
static	updateMetaWithID ($post_id, $args=array())
	Brief. More...
static	thumbnailWithID ($post_id, $size= 'full')
	Get thumbnail image. More...
static	imageAttachmentsWithID ($post_id, $size= 'full', $index=1)
	Attachment image. More...
static	imageContentWithID ($post_id)
	image in post content More...

Detailed Description

Useful class to manage mail as post

Overview

Extends WPDKPost with useful method and property to mail

Author

=undo= info@.nosp@m.wpxt.nosp@m.re.me

Copyright

Copyright (C) 2013 wpXtreme Inc. All Rights Reserved.

Date

2013-02-18

Version

1.0.0

Definition at line 15 of file wpdk-mail.php.

Constructor & Destructor Documentation

__construct	(		$mail = null,
			$post_type = 'page'
	)

Construct.

Create an instance of WPDKMail class

Parameters

string | int | object | null	$mail	Optional. Post ID, post object, post slug or null
string	$post_type	Optional. If $record is a string (slug) then this is the post type where search. Default is 'page'

Returns

WPDKMail

Definition at line 57 of file wpdk-mail.php.

Member Function Documentation

send	(		$to,
			$subject = false,
			$from = '',
			$placeholders = array()
	)

Send mail.

Perform a send mail. Return FALSE if an error occour.

Parameters

string | int	$to	String target 'name <email>' or user id
bool | string	$subject	Optional. String subject for this mail, if FALSE will bw used the title of post-mail
bool | int | string	$from	Optional. String from 'name <email>' or user id, set to empty to use default blog name and admin email
array	$placeholders	Optional. A Key value pairs with placeholders substitution.

Returns

bool

Definition at line 80 of file wpdk-mail.php.

Field Documentation

string $bcc = ''

Carbon copy.

Header for carbon copy

Since

1.4.9

Definition at line 35 of file wpdk-mail.php.

string $cc = ''

Carbon copy.

Header for carbon copy

Since

1.4.9

Definition at line 25 of file wpdk-mail.php.

---

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

• classes/core/wpdk-mail.php