SendGrid\Email
Synopsis
class Email
{
- // members
- private $from;
- protected $use_headers;
- // methods
- public void __construct()
- private void _removeFromList()
- public void addTo()
- public void setTo()
- public void setTos()
- public void removeTo()
- public void getTos()
- public void setFrom()
- public void getFrom()
- public void setFromName()
- public void getFromName()
- public void setReplyTo()
- public void getReplyTo()
- public void setCc()
- public void setCcs()
- public void addCc()
- public void removeCc()
- public void getCcs()
- public void setBcc()
- public void setBccs()
- public void addBcc()
- public void removeBcc()
- public void getBccs()
- public void setSubject()
- public void getSubject()
- public void setText()
- public void getText()
- public void setHtml()
- public void getHtml()
- public void setAttachments()
- public void setAttachment()
- public void addAttachment()
- public void getAttachments()
- public void removeAttachment()
- private void _getAttachmentInfo()
- public void setCategories()
- public void setCategory()
- public void addCategory()
- public void removeCategory()
- public void setSubstitutions()
- public void addSubstitution()
- public void setSections()
- public void addSection()
- public void setUniqueArguments()
- public void addUniqueArgument()
- public void setFilterSettings()
- public void addFilterSetting()
- public void getHeaders()
- public void getSmtpapiHeaders()
- public void getHeadersJson()
- public void getSmtpapiHeadersJson()
- public void setHeaders()
- public void setSmtpapiHeaders()
- public void addHeader()
- public void addSmtpapiHeader()
- public void removeHeader()
- public void removeSmtpapiHeader()
- public void getMessageHeaders()
- public void getMessageHeadersJson()
- public void setMessageHeaders()
- public void addMessageHeader()
- public void removeMessageHeader()
- public void useHeaders()
- public void setRecipientsInHeader()
- protected boolean _isHeadersRequired()
- protected boolean _preferNotToUseHeaders()
- public void toWebFormat()
Members
private
- $from
protected
- $use_headers
Methods
private
- _getAttachmentInfo()
- _removeFromList() — _removeFromList Given a list of key/value pairs, removes the associated keys where a value matches the given string ($item)
protected
- _isHeadersRequired() — isHeaderRequired determines whether or not we need to force recipients through the smtpapi headers
- _preferNotToUseHeaders() — _preferNotToUseHeaders There are certain cases in which headers are not a preferred choice to send email, as it limits some basic email functionality. Here, we check for any of those rules, and add them in to decide whether or not to use headers
public
- __construct()
- addAttachment()
- addBcc()
- addCategory()
- addCc()
- addFilterSetting()
- addHeader()
- addMessageHeader()
- addSection()
- addSmtpapiHeader()
- addSubstitution()
- addTo()
- addUniqueArgument()
- getAttachments()
- getBccs()
- getCcs()
- getFrom()
- getFromName()
- getHeaders()
- getHeadersJson()
- getHtml()
- getMessageHeaders()
- getMessageHeadersJson()
- getReplyTo()
- getSmtpapiHeaders()
- getSmtpapiHeadersJson()
- getSubject()
- getText()
- getTos()
- removeAttachment()
- removeBcc()
- removeCategory()
- removeCc()
- removeHeader()
- removeMessageHeader()
- removeSmtpapiHeader()
- removeTo()
- setAttachment()
- setAttachments()
- setBcc()
- setBccs()
- setCategories()
- setCategory()
- setCc()
- setCcs()
- setFilterSettings()
- setFrom()
- setFromName()
- setHeaders()
- setHtml()
- setMessageHeaders()
- setRecipientsInHeader()
- setReplyTo()
- setSections()
- setSmtpapiHeaders()
- setSubject()
- setSubstitutions()
- setText()
- setTo()
- setTos()
- setUniqueArguments()
- toWebFormat()
- useHeaders() — useHeaders Checks to see whether or not we can or should you headers. In most cases, we prefer to send our recipients through the headers, but in some cases, we actually don't want to. However, there are certain circumstances in which we have to.