Download the PHP package herald-project/client-php without Composer
On this page you can find all versions of the php package herald-project/client-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package client-php
Herald PHP client
Send beautiful messages from your application.
Installation
Example
CLI usage
You can use the bin/herald-client
CLI application to run commands against your herald server.
The application needs a couple of configuration directives to work:
- username + password: The account you use to connect. Either a user account, or an API key+secret pair
- apiurl: the base url of herald, (i.e. https://herald.dev) with postfix
/api/v2
- account + library: This is the library identifier you use to create your templates, layouts and transports
You can pass this data in 3 ways:
Individual options:
For example:
./bin/herald-client --username=x --password=y --apiurl=https://herald.dev/api/v2 --account=test --library=test template:exists welcome
A single DSN
For example:
./bin/herald-client --dsn=https://x:[email protected]/test/test/mandrill
By environment variables
You can define the environment variable HERALD_DSN
with a valid URL, this way you don't
need to pass any options to the CLI application
By .env
The Herald CLI application loads .env
before running any commands, allowing you to create a .env
file
like this:
This way you also don't need to pass any options for each command
Example commands
# get list of all contact lists
bin/herald-client list:list
# get list of contacts in contact list #1
bin/herald-client list:contacts 1
# get list of segments for list #1
bin/herald-client list:segments 1
# get available list_fields for list #1
bin/herald-client list:fields 1
# delete contact #42
#bin/herald-client contact:delete 42
# get properties of contact #6
bin/herald-client contact:properties 6
# add new contact with address '[email protected]' to list #1
bin/herald-client contact:add 1 [email protected]
# add new property to contact #36 for list field id #4
bin/herald-client property:add 36 4 "some value"
# send message based on template #7 to all contacts in list #1
bin/herald-client list:send 1 7
# send message based on template #1 to contacts in list #1 that meet the conditions for segment #6
bin/herald-client list:send 1 7 6