メールを送信する
API名
MailSendMails
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
send_mail | mail:MailSendMailType | 1 ~ 無制限 | 送信するメール |
例
<parameters> <send_mail xmlns="" account_id="1" from_string="admin@sample-mail-server" sender_string="test user" to_string="admin@sample-mail-server"> <mail xmlns="" key="dummy" version="dummy" subject="test-title" body="test-body" folder_key="2"> </mail> </send_mail> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
mail:MailType | 0 ~ 無制限 | 送信したメールの詳細情報 |
例
<returns> <mail xmlns:mail="http://schemas.cybozu.co.jp/mail/2008" key="33" version="1283148157" subject="test-title" body="test-body" folder_key="3" date="2010-08-30T06:02:37Z" read="2010-08-30T06:02:37Z" size="343" is_draft="false" is_sent="true"> <mail:from name="Administrator" address="admin@sample-mail-server" /> <mail:to address="admin@sample-mail-server" /> <mail:source id="22" size="343" /> </mail> </returns>
メールを返信する
返信するメールをリクエストのパラメーターとして受け取り、返信処理を実行後、返信したメールの詳細情報をレスポンスとして返す API です。この API は、書式編集を利用したメール本文の送信に対応していません。
API名
MailReplyMails
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
@reply_all | xsd:boolean | 1 | 全員への返信
|
reply_mail | mail:MailSendMailType | 1 ~ 無制限 | 返信するメール |
例
<parameters reply_all="false"> <reply_mail xmlns="" account_id="1" from_string="admin@sample-mail-server" sender_string="admin@sample-mail-server" to_string="admin@sample-mail-server"> <mail xmlns="" key="34" version="dummy" subject="reply-test" body="reply-content" is_sent="true" folder_key="2"> </mail> </reply_mail> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
mail:MailType | 0 ~ 無制限 | 返信したメールの詳細情報 |
例
<returns> <mail xmlns:mail="http://schemas.cybozu.co.jp/mail/2008" key="35" version="1283149239" subject="reply-test" body="reply-content" folder_key="3" date="2010-08-30T06:20:39Z" read="2010-08-30T06:20:39Z" size="405" is_draft="false" is_sent="true"> <mail:from name="Administrator" address="admin@sample-mail-server" /> <mail:to address="admin@sample-mail-server" /> <mail:source id="24" size="405" /> </mail> </returns>
メールを転送する
転送するメールをリクエストのパラメーターとして受け取り、転送処理を実行後、転送したメールの詳細情報をレスポンスとして返す API です。この API は、書式編集を利用したメール本文の送信に対応していません。
API名
MailForwardMails
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
forward_mail | mail:MailForwardMailType | 1 ~ 無制限 | 転送するメール |
例
<parameters> <forward_mail xmlns="" mail_id="36" account_id="1" to_string="test@sample-mail-server"> <mail xmlns="" key="36" version="dummy" subject="forward-test" body="forward-content" folder_key="2"> </mail> </forward_mail> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
mail:MailType | 0 ~ 無制限 | 転送したメールの詳細情報 |
例
<returns> <mail xmlns:mail="http://schemas.cybozu.co.jp/mail/2008" key="37" version="1283149606" subject="forward-test" body="forward-content" folder_key="3" date="2010-08-30T06:26:46Z" read="2010-08-30T06:26:46Z" size="455" is_draft="false" is_sent="true"> <mail:from name="Administrator" address="admin@sample-mail-server" /> <mail:to address="test@sample-mail-server" /> <mail:source id="26" size="455" /> </mail> </returns>
メールを下書き保存する
下書き保存するメールをリクエストのパラメーターとして受け取り、下書き処理を実行後、下書き保存したメールの詳細情報をレスポンスとして返す API です。この API は、書式編集を利用したメール本文の送信に対応していません。
API名
MailSaveDraftMails
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
save_draft | mail:MailDraftMailType | 1 ~ 無制限 | 下書き保存するメール |
例
<parameters> <save_mail xmlns="" operation="send" account_id="1"> <mail xmlns="" key="0" version="0" subject="test-subject" body="test-body" folder_key="1"> </mail> </save_mail> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
mail:MailType | 0 ~ 無制限 | 下書き保存したメールの詳細情報 |
例
<returns> <mail xmlns:mail="http://schemas.cybozu.co.jp/mail/2008" key="5" version="1283127017" subject="test-subject" body="test-body" folder_key="4" date="2010-08-30T00:10:17Z" read="2010-08-30T00:10:17Z" size="9" is_draft="true" is_sent="true"> </mail> </returns>
開封確認を行う
開封確認の処理情報をリクエストのパラメーターとして受け取り、開封確認の処理を行う API です。
API名
MailOpenDispositionNotifications
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
operation | mail:MailOpenDispositionNotificationOperationType | 1 ~ 無制限 | 開封確認の処理方法 |
例
<parameters> <operation xmlns="" account_id="1" mail_id="24" type="open"></operation> </parameters>
レスポンス
パラメーター名 | 型 | パラメーター数 | 説明 |
mail:MailType | 0 ~ 無制限 | 開封確認を処理したメールの詳細情報 |
例
<returns> <mail xmlns:mail="http://schemas.cybozu.co.jp/mail/2008" key="24" version="1283132082" subject="disposition test" body="disposition test" folder_key="2" date="2010-08-30T01:34:38Z" read="2010-08-30T01:34:45Z" size="676" is_draft="false" is_sent="false" is_sent_disposition_notification="1"> <mail:from name="Administrator" address="admin@sample-mail-server" /> <mail:to address="admin@sample-mail-server" /> <mail:disposition_notification_to name="Administrator" address="admin@sample-mail-server" /> <mail:source id="17" size="676" /> </mail> </returns>
メールを削除する
削除するメールの ID をリクエストのパラメーターとして受け取り、メールを削除する API です。
API名
MailRemoveMails
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 3.0.0以降
リクエスト
パラメーター名 | 型 | パラメーター数 | 説明 |
mail_id/text() | base:IDType | 1 ~ 無制限 | 削除するメールのID |
例
<parameters> <mail_id xmlns="">5</mail_id> </parameters>
レスポンス
なし
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。