Overview

Namespaces

  • Crunchmail
    • Collections
    • Entities
    • Exception
    • PHPUnit
    • Resources

Classes

  • AttachmentEntity
  • ContactEntity
  • ContactListEntity
  • ContactQueueEntity
  • DomainEntity
  • GenericEntity
  • MessageEntity
  • RecipientEntity
  • Overview
  • Namespace
  • Class

Class MessageEntity

Message entity class

Crunchmail\Entities\GenericEntity
Extended by Crunchmail\Entities\MessageEntity
Namespace: Crunchmail\Entities
Located at Entities/MessageEntity.php
Methods summary
public string
# __toString( )

To string

To string

Returns

string

Overrides

Crunchmail\Entities\GenericEntity::__toString()
public string
# readableStatus( integer $status,… )

Return a human readable status from int status

Return a human readable status from int status

Deprecated

this should be handle by application

Parameters

$status,…

Returns

string
public mixed
# send( )

Sending message via crunchmail API

Sending message via crunchmail API

Returns

mixed
public Crunchmail\Entity\GenericEntity
# previewSend( array $recipients )

Send the preview to the given recipients. You can only call it from a message entity

Send the preview to the given recipients. You can only call it from a message entity

Parameters

$recipients
list of recipients for the test

Returns

Crunchmail\Entity\GenericEntity

Example

$message->preview->send($email)

Fixme

move somewhere else, resolve conflict
public stdClass
# addAttachment( string $path )

Add an attachment to the message

Add an attachment to the message

Parameters

$path
File path

Returns

stdClass
public Crunchmail\Entity\RecipientEntity
# addRecipients( mixed $recipients )

Overwrite post for this resource, because of its special format

Overwrite post for this resource, because of its special format

Parameters

$recipients
string or array

Returns

Crunchmail\Entity\RecipientEntity
public
# hasIssue( )

Return true if the message status is message_ok

Return true if the message status is message_ok

public
# isReady( )

Return true if the message status is message_ok

Return true if the message status is message_ok

public
# isSending( object $msg,… )

Return true if the message is being sent

Return true if the message is being sent

Parameters

$msg,…
Message
public
# hasBeenSent( )

Return true if the message has been sent

Return true if the message has been sent

Methods inherited from Crunchmail\Entities\GenericEntity
__call(), __construct(), __get(), __isset(), __unset(), getBody(), getLink()
Properties summary
protected static array $exposeLinks

Shortcuts to links href value

Shortcuts to links href value

# ['archive_url']
Properties inherited from Crunchmail\Entities\GenericEntity
$_body, $_resource, $links, $resources
API documentation generated by ApiGen