MailFrontServiceInterface
in
MailFrontServiceInterface
Table of Contents
- confirm() : EntityInterface
- 送信データの確認を行う
- createMailData() : array<string|int, mixed>
- メール送信用のデータを生成する
- getAdminMail() : string
- 管理者メールを取得する
- getAttachments() : array<string|int, mixed>
- 添付ファイルのパスを取得する
- getConfirmTemplate() : string
- メールフォーム確認画面のテンプレート名を取得する
- getEditLink() : array<string|int, mixed>
- 編集リンクを取得する
- getIndexTemplate() : string
- メールフォームのテンプレート名を取得する
- getMailFields() : ResultSetInterface
- メールコンテンツに関連するメールフィールドを取得する
- getThanksTemplate() : string
- メールフォームの完了画面用のテンプレート名を取得する
- getUnpublishTemplate() : string
- メールフォームの非公開状態用のテンプレート名を取得する
- getUserMail() : string
- ユーザーメールを取得する
- getViewVarsForConfirm() : array<string|int, mixed>
- 確認画面用の View 変数を取得する
- getViewVarsForIndex() : array<string|int, mixed>
- メールフォーム用の View 変数を取得する
- isAccepting() : bool
- フォームが公開中かどうかチェックする
- sendMail() : mixed
- メールを送信する
- setupPreviewForIndex() : void
- プレビュー用のセットアップをする
Methods
confirm()
送信データの確認を行う
public
confirm(EntityInterface $mailContent, array<string|int, mixed> $postData) : EntityInterface
Parameters
- $mailContent : EntityInterface
- $postData : array<string|int, mixed>
Tags
Return values
EntityInterface —createMailData()
メール送信用のデータを生成する
public
createMailData(EntityInterface $mailConfig, EntityInterface $mailContent, ResultSetInterface $mailFields, EntityInterface $mailMessage, array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
- $mailConfig : EntityInterface
- $mailContent : EntityInterface
- $mailFields : ResultSetInterface
- $mailMessage : EntityInterface
- $options : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getAdminMail()
管理者メールを取得する
public
getAdminMail(EntityInterface $mailContent) : string
Parameters
- $mailContent : EntityInterface
Tags
Return values
string —getAttachments()
添付ファイルのパスを取得する
public
getAttachments(ResultSetInterface $mailFields, EntityInterface $mailMessage) : array<string|int, mixed>
Parameters
- $mailFields : ResultSetInterface
- $mailMessage : EntityInterface
Tags
Return values
array<string|int, mixed> —getConfirmTemplate()
メールフォーム確認画面のテンプレート名を取得する
public
getConfirmTemplate(EntityInterface $mailContent) : string
Parameters
- $mailContent : EntityInterface
Tags
Return values
string —getEditLink()
編集リンクを取得する
public
getEditLink(int $mailContentId) : array<string|int, mixed>
Parameters
- $mailContentId : int
Tags
Return values
array<string|int, mixed> —getIndexTemplate()
メールフォームのテンプレート名を取得する
public
getIndexTemplate(EntityInterface $mailContent) : string
Parameters
- $mailContent : EntityInterface
Tags
Return values
string —getMailFields()
メールコンテンツに関連するメールフィールドを取得する
public
getMailFields(int $mailContentId) : ResultSetInterface
Parameters
- $mailContentId : int
Tags
Return values
ResultSetInterface —getThanksTemplate()
メールフォームの完了画面用のテンプレート名を取得する
public
getThanksTemplate(EntityInterface $mailContent) : string
Parameters
- $mailContent : EntityInterface
Tags
Return values
string —getUnpublishTemplate()
メールフォームの非公開状態用のテンプレート名を取得する
public
getUnpublishTemplate(EntityInterface $mailContent) : string
Parameters
- $mailContent : EntityInterface
Tags
Return values
string —getUserMail()
ユーザーメールを取得する
public
getUserMail(EntityInterface $mailFields, EntityInterface $mailMessage) : string
Parameters
- $mailFields : EntityInterface
- $mailMessage : EntityInterface
Tags
Return values
string —getViewVarsForConfirm()
確認画面用の View 変数を取得する
public
getViewVarsForConfirm(EntityInterface $mailContent, EntityInterface $mailMessage) : array<string|int, mixed>
Parameters
- $mailContent : EntityInterface
- $mailMessage : EntityInterface
Tags
Return values
array<string|int, mixed> —getViewVarsForIndex()
メールフォーム用の View 変数を取得する
public
getViewVarsForIndex(EntityInterface|MailContent $mailContent, EntityInterface $mailMessage) : array<string|int, mixed>
Parameters
- $mailContent : EntityInterface|MailContent
- $mailMessage : EntityInterface
Tags
Return values
array<string|int, mixed> —isAccepting()
フォームが公開中かどうかチェックする
public
isAccepting(EntityInterface|MailContent $mailContent) : bool
Parameters
- $mailContent : EntityInterface|MailContent
Tags
Return values
bool —sendMail()
メールを送信する
public
sendMail(EntityInterface $mailContent, EntityInterface $mailMessage, array<string|int, mixed> $sendEmailOptions) : mixed
Parameters
- $mailContent : EntityInterface
- $mailMessage : EntityInterface
- $sendEmailOptions : array<string|int, mixed>
Tags
Return values
mixed —setupPreviewForIndex()
プレビュー用のセットアップをする
public
setupPreviewForIndex(Controller $controller) : void
Parameters
- $controller : Controller